@fluidgrids/workflows 0.0.0-stage → 2026.1027.0

package/schema/ir-v2.schema.json

@@ -0,0 +1,655 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.fluidgrids.ai/schemas/workflow-ir-v2.schema.json",
+  "title": "FluidGrids workflow definition (IR schema version 2)",
+  "description": "The canonical workflow definition (definitionJson). Version 2 is a strict superset of version 1: a document without schemaVersion is version 1 and validates here unchanged.",
+  "type": "object",
+  "required": [
+    "data"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "enum": [
+        1,
+        2
+      ],
+      "description": "Absent means 1."
+    },
+    "key": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "description": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "interface": {
+      "$ref": "#/$defs/interface"
+    },
+    "code": {
+      "$ref": "#/$defs/code"
+    },
+    "authoring": {
+      "$ref": "#/$defs/authoring"
+    },
+    "data": {
+      "type": "object",
+      "required": [
+        "nodes",
+        "edges"
+      ],
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/node"
+          }
+        },
+        "edges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/edge"
+          }
+        },
+        "stickyNotes": {
+          "type": "array",
+          "items": {
+            "type": "object"
+          }
+        }
+      }
+    },
+    "config": {
+      "$ref": "#/$defs/config"
+    },
+    "pinnedData": {
+      "type": "object"
+    },
+    "meta": {
+      "type": "object",
+      "properties": {
+        "layout": {
+          "type": "object",
+          "description": "Positions and sizes keyed by node id, preserved verbatim by every code tool."
+        }
+      }
+    },
+    "tags": {
+      "type": "array"
+    }
+  },
+  "$defs": {
+    "position": {
+      "type": "object",
+      "required": [
+        "x",
+        "y"
+      ],
+      "properties": {
+        "x": {
+          "type": "number"
+        },
+        "y": {
+          "type": "number"
+        }
+      }
+    },
+    "connectionRef": {
+      "type": "object",
+      "required": [
+        "connectionId",
+        "adapter"
+      ],
+      "properties": {
+        "connectionId": {
+          "type": "string"
+        },
+        "adapter": {
+          "type": "string"
+        }
+      }
+    },
+    "retryConfig": {
+      "type": "object",
+      "properties": {
+        "maxRetries": {
+          "type": "number",
+          "minimum": 0
+        },
+        "retryDelay": {
+          "type": "number",
+          "minimum": 0
+        },
+        "backoffMultiplier": {
+          "type": "number"
+        },
+        "maxDelay": {
+          "type": "number",
+          "minimum": 0
+        },
+        "retryOnErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "nonRetryableErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "errorConfig": {
+      "type": "object",
+      "properties": {
+        "onError": {
+          "type": "string"
+        },
+        "errorBranchId": {
+          "type": "string"
+        },
+        "retryConfig": {
+          "$ref": "#/$defs/retryConfig"
+        },
+        "timeout": {
+          "type": "object",
+          "properties": {
+            "duration": {
+              "type": "number",
+              "minimum": 0
+            },
+            "onTimeout": {
+              "type": "string"
+            },
+            "timeoutBranchId": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "executionSettings": {
+      "type": "object",
+      "properties": {
+        "alwaysOutputData": {
+          "type": "boolean"
+        },
+        "executeOnce": {
+          "type": "boolean"
+        },
+        "runOn": {
+          "type": "object"
+        }
+      }
+    },
+    "node": {
+      "type": "object",
+      "required": [
+        "id",
+        "type"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "type": {
+          "type": "string",
+          "minLength": 1
+        },
+        "label": {
+          "type": "string"
+        },
+        "position": {
+          "$ref": "#/$defs/position"
+        },
+        "operation_name": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        },
+        "args": {
+          "type": "object",
+          "properties": {
+            "state": {
+              "type": "object"
+            },
+            "context": {
+              "type": "object"
+            },
+            "connections": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/connectionRef"
+              }
+            },
+            "credentials": {
+              "type": "array",
+              "items": {
+                "type": "object"
+              }
+            }
+          }
+        },
+        "errorConfig": {
+          "$ref": "#/$defs/errorConfig"
+        },
+        "executionSettings": {
+          "$ref": "#/$defs/executionSettings"
+        },
+        "disabled": {
+          "type": "boolean"
+        },
+        "data": {
+          "type": "object"
+        },
+        "config": {
+          "type": "object"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "internal:code-workflow"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "args"
+            ],
+            "properties": {
+              "args": {
+                "required": [
+                  "state"
+                ],
+                "properties": {
+                  "state": {
+                    "type": "object",
+                    "required": [
+                      "workflowFn"
+                    ],
+                    "properties": {
+                      "workflowFn": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "inputMapping": {},
+                      "taskQueue": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "waitForCompletion": {
+                        "type": "boolean"
+                      },
+                      "timeout": {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      "failOnError": {
+                        "type": "boolean"
+                      },
+                      "parentClosePolicy": {
+                        "enum": [
+                          "TERMINATE",
+                          "ABANDON",
+                          "REQUEST_CANCEL"
+                        ]
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "internal:wait-for-signal"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "args"
+            ],
+            "properties": {
+              "args": {
+                "required": [
+                  "state"
+                ],
+                "properties": {
+                  "state": {
+                    "type": "object",
+                    "required": [
+                      "signalName"
+                    ],
+                    "properties": {
+                      "signalName": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "limitWait": {
+                        "type": "object",
+                        "required": [
+                          "amount",
+                          "unit"
+                        ],
+                        "properties": {
+                          "amount": {
+                            "type": "number",
+                            "exclusiveMinimum": 0
+                          },
+                          "unit": {
+                            "type": "string"
+                          }
+                        }
+                      },
+                      "payloadSchema": {
+                        "type": "object"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      ]
+    },
+    "edge": {
+      "type": "object",
+      "required": [
+        "source",
+        "target"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "source": {
+          "type": "string",
+          "minLength": 1
+        },
+        "target": {
+          "type": "string",
+          "minLength": 1
+        },
+        "sourceHandle": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "targetHandle": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "type": {
+          "type": "string"
+        },
+        "label": {},
+        "data": {
+          "type": "object"
+        },
+        "mapping": {
+          "type": "object"
+        }
+      }
+    },
+    "config": {
+      "type": "object",
+      "properties": {
+        "maxParallelism": {
+          "type": "number",
+          "minimum": 1
+        },
+        "timeout": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Run timeout in seconds."
+        },
+        "executionTimeout": {
+          "type": [
+            "number",
+            "string"
+          ],
+          "description": "Seconds or a duration string."
+        },
+        "workflowTaskTimeout": {
+          "type": [
+            "number",
+            "string"
+          ],
+          "description": "Seconds or a duration string."
+        },
+        "versioningBehavior": {
+          "enum": [
+            "PINNED",
+            "AUTO_UPGRADE"
+          ]
+        }
+      }
+    },
+    "interface": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "input": {
+          "type": "object"
+        },
+        "output": {
+          "type": "object"
+        },
+        "signals": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "payload": {
+                "type": "object"
+              },
+              "description": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "queries": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "args": {
+                "type": "object"
+              },
+              "result": {
+                "type": "object"
+              },
+              "description": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "updates": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "args": {
+                "type": "object"
+              },
+              "result": {
+                "type": "object"
+              },
+              "description": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "open": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "signals": {
+              "type": "boolean"
+            },
+            "queries": {
+              "type": "boolean"
+            },
+            "updates": {
+              "type": "boolean"
+            }
+          }
+        }
+      }
+    },
+    "code": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "language",
+        "buildId"
+      ],
+      "properties": {
+        "language": {
+          "enum": [
+            "typescript",
+            "python"
+          ]
+        },
+        "sdk": {
+          "type": "string"
+        },
+        "buildId": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        },
+        "bundleRef": {
+          "type": "string"
+        },
+        "sourceRef": {
+          "type": "string"
+        },
+        "entry": {
+          "type": "string"
+        },
+        "exports": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "workflows": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "interface": {
+                    "$ref": "#/$defs/interface"
+                  },
+                  "taskQueue": {
+                    "type": "string"
+                  }
+                }
+              }
+            },
+            "activities": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "taskQueue": {
+                    "type": "string"
+                  },
+                  "input": {
+                    "type": "object"
+                  },
+                  "output": {
+                    "type": "object"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "determinism": {
+          "enum": [
+            "isolate",
+            "worker"
+          ]
+        }
+      }
+    },
+    "authoring": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "mode": {
+          "enum": [
+            "canvas",
+            "code",
+            "hybrid"
+          ]
+        },
+        "generator": {
+          "enum": [
+            "builder",
+            "sdk-ts",
+            "sdk-py",
+            "ai",
+            "import",
+            "lift"
+          ]
+        },
+        "generatorVersion": {
+          "type": "string"
+        },
+        "sourceHash": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        },
+        "liftedFrom": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "workflowKey": {
+              "type": "string"
+            },
+            "version": {
+              "type": "string"
+            },
+            "fidelity": {
+              "enum": [
+                "lossless",
+                "lossy"
+              ]
+            }
+          }
+        }
+      }
+    }
+  }
+}