@autoweb/domain-models 1.0.0

package/schemas/flow-validation.json

@@ -0,0 +1,311 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://floweb.com/schemas/flow-validation.json",
+  "title": "Flow Validation Models",
+  "description": "Schema for flow validation warnings and errors",
+  "type": "object",
+  "properties": {
+    "flowValidation": {
+      "type": "object",
+      "properties": {
+        "warnings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FlowWarning"
+          }
+        },
+        "loopDetections": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/LoopDetectionResult"
+          }
+        },
+        "validationResults": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FlowValidationResult"
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "FlowWarning": {
+      "type": "object",
+      "description": "Flow validation warning or error",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique warning identifier"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "missing-selector",
+            "infinite-loop",
+            "unreachable-node",
+            "missing-condition",
+            "invalid-reference",
+            "missing-action-reference",
+            "circular-dependency",
+            "duplicate-id",
+            "invalid-variable",
+            "missing-variable",
+            "type-mismatch",
+            "performance-issue",
+            "security-risk"
+          ],
+          "description": "Type of warning"
+        },
+        "severity": {
+          "$ref": "#/$defs/WarningSeverity"
+        },
+        "nodeId": {
+          "type": "string",
+          "description": "ID of the node that triggered the warning"
+        },
+        "nodeName": {
+          "type": "string",
+          "description": "Name of the node that triggered the warning"
+        },
+        "message": {
+          "type": "string",
+          "description": "Warning message"
+        },
+        "description": {
+          "type": "string",
+          "description": "Detailed description of the warning"
+        },
+        "affectedNodes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of other affected node IDs"
+        },
+        "suggestion": {
+          "type": "string",
+          "description": "Suggested fix for the warning"
+        },
+        "category": {
+          "type": "string",
+          "enum": ["logic", "performance", "security", "usability", "compatibility"],
+          "description": "Category of the warning"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the warning was detected"
+        }
+      },
+      "required": ["id", "type", "severity", "nodeId", "nodeName", "message", "description"]
+    },
+    "WarningSeverity": {
+      "type": "string",
+      "enum": ["minor", "medium", "critical", "info"],
+      "description": "Severity level of the warning"
+    },
+    "LoopDetectionResult": {
+      "type": "object",
+      "description": "Result of loop detection analysis",
+      "properties": {
+        "hasLoops": {
+          "type": "boolean",
+          "description": "Whether loops were detected in the flow"
+        },
+        "loops": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/LoopInfo"
+          },
+          "description": "Information about detected loops"
+        },
+        "totalLoops": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of loops detected"
+        },
+        "infiniteLoops": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of potentially infinite loops"
+        }
+      },
+      "required": ["hasLoops", "loops"]
+    },
+    "LoopInfo": {
+      "type": "object",
+      "description": "Information about a detected loop",
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Node IDs that form the loop"
+        },
+        "hasExitCondition": {
+          "type": "boolean",
+          "description": "Whether the loop has a proper exit condition"
+        },
+        "severity": {
+          "$ref": "#/$defs/WarningSeverity"
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the loop issue"
+        },
+        "maxIterations": {
+          "type": "integer",
+          "description": "Maximum iterations if detectable"
+        },
+        "isInfinite": {
+          "type": "boolean",
+          "description": "Whether this appears to be an infinite loop"
+        }
+      },
+      "required": ["nodes", "hasExitCondition", "severity", "description"]
+    },
+    "FlowValidationResult": {
+      "type": "object",
+      "description": "Complete result of flow validation",
+      "properties": {
+        "flowId": {
+          "type": "string",
+          "description": "ID of the validated flow"
+        },
+        "flowName": {
+          "type": "string",
+          "description": "Name of the validated flow"
+        },
+        "isValid": {
+          "type": "boolean",
+          "description": "Whether the flow is valid"
+        },
+        "warnings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FlowWarning"
+          },
+          "description": "List of warnings found"
+        },
+        "errors": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FlowWarning"
+          },
+          "description": "List of errors found (critical warnings)"
+        },
+        "summary": {
+          "$ref": "#/$defs/ValidationSummary"
+        },
+        "validatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When validation was performed"
+        },
+        "validationTime": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Time taken for validation in seconds"
+        }
+      },
+      "required": ["flowId", "isValid", "warnings", "errors", "summary"]
+    },
+    "ValidationSummary": {
+      "type": "object",
+      "description": "Summary statistics of validation results",
+      "properties": {
+        "totalNodes": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of nodes in the flow"
+        },
+        "totalEdges": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of edges in the flow"
+        },
+        "warningCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of warnings"
+        },
+        "errorCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of errors"
+        },
+        "criticalCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of critical severity issues"
+        },
+        "warningsByType": {
+          "type": "object",
+          "description": "Count of warnings by type",
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "warningsBySeverity": {
+          "type": "object",
+          "description": "Count of warnings by severity",
+          "properties": {
+            "minor": {"type": "integer", "minimum": 0},
+            "medium": {"type": "integer", "minimum": 0},
+            "critical": {"type": "integer", "minimum": 0},
+            "info": {"type": "integer", "minimum": 0}
+          }
+        }
+      },
+      "required": ["totalNodes", "totalEdges", "warningCount", "errorCount"]
+    },
+    "NodeValidationResult": {
+      "type": "object",
+      "description": "Validation result for a specific node",
+      "properties": {
+        "nodeId": {
+          "type": "string",
+          "description": "ID of the validated node"
+        },
+        "nodeType": {
+          "type": "string",
+          "description": "Type of the node"
+        },
+        "isValid": {
+          "type": "boolean",
+          "description": "Whether the node is valid"
+        },
+        "warnings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FlowWarning"
+          },
+          "description": "Warnings specific to this node"
+        },
+        "configValidation": {
+          "type": "object",
+          "description": "Validation of node configuration",
+          "properties": {
+            "isValid": {"type": "boolean"},
+            "missingFields": {
+              "type": "array",
+              "items": {"type": "string"}
+            },
+            "invalidFields": {
+              "type": "array",
+              "items": {"type": "string"}
+            },
+            "typeErrors": {
+              "type": "array",
+              "items": {"type": "string"}
+            }
+          }
+        }
+      },
+      "required": ["nodeId", "nodeType", "isValid"]
+    }
+  }
+}

package/schemas/flow.json

@@ -0,0 +1,381 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://floweb.com/schemas/flow.json",
+  "title": "Flow",
+  "description": "Complete flow definition for automation workflows",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Unique identifier for the flow"
+    },
+    "name": {
+      "type": "string",
+      "description": "Human-readable name of the flow"
+    },
+    "description": {
+      "type": "string",
+      "description": "Optional description of the flow"
+    },
+    "tags": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Tags for categorization and filtering"
+    },
+    "parentID": {
+      "type": ["string", "null"],
+      "description": "Parent folder ID for organization"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["flow", "test", "performance"],
+      "description": "Type of the flow"
+    },
+    "actions": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/Action"
+      },
+      "description": "List of actions in the flow"
+    },
+    "edges": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/Edge"
+      },
+      "description": "Connections between actions"
+    },
+    "zoom": {
+      "$ref": "#/$defs/Zoom",
+      "description": "Canvas zoom and pan state"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Creation timestamp"
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Last update timestamp"
+    },
+    "variables": {
+      "$ref": "#/$defs/FlowVariables",
+      "description": "Flow input and output variables"
+    },
+    "parameters": {
+      "$ref": "#/$defs/FlowParameters",
+      "description": "Flow parameters for configuration"
+    },
+    "environment": {
+      "$ref": "#/$defs/Environment",
+      "description": "Environment configuration"
+    },
+    "globalVariables": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/GlobalVariable"
+      },
+      "description": "Global variables available to the flow"
+    },
+    "synced": {
+      "type": "boolean",
+      "description": "Whether the flow is synced with server"
+    },
+    "lastRun": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Last execution timestamp"
+    },
+    "lastResult": {
+      "type": "string",
+      "enum": ["passed", "failed", "pending", "running"],
+      "description": "Result of last execution"
+    }
+  },
+  "required": ["id", "name", "actions", "edges"],
+  "$defs": {
+    "Position": {
+      "type": "object",
+      "properties": {
+        "x": {
+          "type": "number",
+          "description": "X coordinate"
+        },
+        "y": {
+          "type": "number",
+          "description": "Y coordinate"
+        }
+      },
+      "required": ["x", "y"]
+    },
+    "ActionData": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Human-readable label"
+        },
+        "type": {
+          "type": "string",
+          "description": "Action type identifier"
+        },
+        "config": {
+          "type": "object",
+          "description": "Action-specific configuration"
+        }
+      },
+      "required": ["label", "type", "config"]
+    },
+    "Action": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique action identifier"
+        },
+        "type": {
+          "type": "string",
+          "description": "Action type"
+        },
+        "position": {
+          "$ref": "#/$defs/Position"
+        },
+        "data": {
+          "$ref": "#/$defs/ActionData"
+        }
+      },
+      "required": ["id", "type", "position", "data"]
+    },
+    "Edge": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique edge identifier"
+        },
+        "source": {
+          "type": "string",
+          "description": "Source action ID"
+        },
+        "sourceHandle": {
+          "type": "string",
+          "description": "Source handle identifier"
+        },
+        "target": {
+          "type": "string",
+          "description": "Target action ID"
+        },
+        "targetHandle": {
+          "type": "string",
+          "description": "Target handle identifier"
+        },
+        "type": {
+          "type": "string",
+          "default": "step",
+          "description": "Edge type"
+        },
+        "data": {
+          "type": "object",
+          "description": "Additional edge data"
+        }
+      },
+      "required": ["id", "source", "target"]
+    },
+    "Zoom": {
+      "type": "object",
+      "properties": {
+        "x": {
+          "type": "number",
+          "description": "Pan X position"
+        },
+        "y": {
+          "type": "number",
+          "description": "Pan Y position"
+        },
+        "zoom": {
+          "type": "number",
+          "description": "Zoom level"
+        }
+      },
+      "required": ["x", "y", "zoom"]
+    },
+    "Variable": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Variable identifier"
+        },
+        "name": {
+          "type": "string",
+          "description": "Variable name"
+        },
+        "type": {
+          "type": "string",
+          "description": "Variable data type"
+        },
+        "value": {
+          "type": "string",
+          "description": "Variable value"
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional description"
+        },
+        "isOutput": {
+          "type": "boolean",
+          "description": "Whether this is an output variable"
+        }
+      },
+      "required": ["id", "name", "type", "value"]
+    },
+    "FlowVariables": {
+      "type": "object",
+      "properties": {
+        "input": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Variable"
+          },
+          "description": "Input variables"
+        },
+        "output": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Variable"
+          },
+          "description": "Output variables"
+        }
+      },
+      "required": ["input", "output"]
+    },
+    "FlowParameters": {
+      "type": "object",
+      "properties": {
+        "input": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Variable"
+          },
+          "description": "Input parameters"
+        },
+        "output": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Variable"
+          },
+          "description": "Output parameters"
+        }
+      },
+      "required": ["input", "output"]
+    },
+    "EnvironmentVariable": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Variable identifier"
+        },
+        "name": {
+          "type": "string",
+          "description": "Variable name"
+        },
+        "type": {
+          "type": "string",
+          "description": "Variable data type"
+        },
+        "value": {
+          "type": "string",
+          "description": "Variable value"
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional description"
+        }
+      },
+      "required": ["id", "name", "type", "value"]
+    },
+    "Environment": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Environment identifier"
+        },
+        "name": {
+          "type": "string",
+          "description": "Environment name"
+        },
+        "variables": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/EnvironmentVariable"
+          },
+          "description": "Environment variables"
+        },
+        "description": {
+          "type": "string",
+          "description": "Environment description"
+        },
+        "isDefault": {
+          "type": "boolean",
+          "description": "Whether this is the default environment"
+        },
+        "isActive": {
+          "type": "boolean",
+          "description": "Whether this environment is active"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Creation timestamp"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Last update timestamp"
+        }
+      },
+      "required": ["id", "name", "variables"]
+    },
+    "GlobalVariable": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Variable identifier"
+        },
+        "name": {
+          "type": "string",
+          "description": "Variable name"
+        },
+        "type": {
+          "type": "string",
+          "description": "Variable data type"
+        },
+        "value": {
+          "type": "string",
+          "description": "Variable value"
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional description"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Creation timestamp"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Last update timestamp"
+        }
+      },
+      "required": ["id", "name", "type", "value"]
+    }
+  }
+}