@autoweb/domain-models 1.0.0

package/schemas/debug.json

@@ -0,0 +1,203 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://floweb.com/schemas/debug.json",
+  "title": "Debug Models",
+  "description": "Schema for debug session management, states, and execution control",
+  "type": "object",
+  "$defs": {
+    "DebugState": {
+      "type": "string",
+      "enum": [
+        "ready",
+        "running",
+        "paused",
+        "stepping",
+        "completed",
+        "error",
+        "stopped"
+      ],
+      "description": "Debug session states following the state machine specification"
+    },
+    "PauseReason": {
+      "type": "string",
+      "enum": [
+        "breakpoint",
+        "manual",
+        "error",
+        "step"
+      ],
+      "description": "Reasons for debug execution pause"
+    },
+    "Breakpoint": {
+      "type": "object",
+      "description": "Represents a breakpoint in debug execution",
+      "properties": {
+        "nodeId": {
+          "type": "string",
+          "description": "Action/node ID where breakpoint is set"
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the breakpoint is active"
+        },
+        "hitCount": {
+          "type": "integer",
+          "description": "Number of times this breakpoint has been hit",
+          "default": 0
+        }
+      },
+      "required": ["nodeId", "enabled"]
+    },
+    "DebugExecutionInfo": {
+      "type": "object",
+      "description": "Information about current debug execution state",
+      "properties": {
+        "currentNodeId": {
+          "type": ["string", "null"],
+          "description": "ID of the action currently being executed or about to execute"
+        },
+        "currentActionIndex": {
+          "type": "integer",
+          "description": "Zero-based index of current action in execution order",
+          "default": 0
+        },
+        "totalActions": {
+          "type": "integer",
+          "description": "Total number of actions in the flow",
+          "default": 0
+        },
+        "executedActions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of action IDs that have been executed",
+          "default": []
+        },
+        "nextBreakpoint": {
+          "type": ["string", "null"],
+          "description": "ID of the next breakpoint that will be hit"
+        }
+      },
+      "required": ["currentNodeId", "currentActionIndex", "totalActions", "executedActions", "nextBreakpoint"]
+    },
+    "DebugSession": {
+      "type": "object",
+      "description": "Represents a single debug execution session",
+      "properties": {
+        "sessionId": {
+          "type": "string",
+          "description": "Unique identifier for the debug session"
+        },
+        "flowId": {
+          "type": "string",
+          "description": "ID of the flow being debugged"
+        },
+        "breakpoints": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Set of action IDs where execution should pause",
+          "default": []
+        },
+        "state": {
+          "$ref": "#/$defs/DebugState",
+          "default": "ready"
+        },
+        "currentActionId": {
+          "type": ["string", "null"],
+          "description": "ID of the action currently being executed or about to execute"
+        },
+        "currentActionIndex": {
+          "type": "integer",
+          "description": "Zero-based index of current action in execution order",
+          "default": 0
+        },
+        "executedActions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of action IDs that have been executed",
+          "default": []
+        },
+        "pauseRequested": {
+          "type": "boolean",
+          "description": "Flag indicating manual pause was requested",
+          "default": false
+        },
+        "stopRequested": {
+          "type": "boolean",
+          "description": "Flag indicating stop was requested",
+          "default": false
+        },
+        "createdAt": {
+          "type": "number",
+          "description": "Timestamp when session was created (Unix timestamp)"
+        },
+        "lastUpdated": {
+          "type": "number",
+          "description": "Timestamp of last state change (Unix timestamp)"
+        }
+      },
+      "required": ["sessionId", "flowId", "breakpoints", "state"]
+    },
+    "DebugActionUpdate": {
+      "type": "object",
+      "description": "Real-time update sent during debug execution",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "debug_action_started",
+            "debug_action_completed",
+            "debug_action_failed",
+            "debug_paused",
+            "debug_resumed",
+            "debug_completed",
+            "debug_stopped",
+            "debug_error"
+          ],
+          "description": "Type of debug update"
+        },
+        "sessionId": {
+          "type": "string",
+          "description": "Debug session ID"
+        },
+        "actionId": {
+          "type": ["string", "null"],
+          "description": "Action ID related to this update"
+        },
+        "actionIndex": {
+          "type": ["integer", "null"],
+          "description": "Index of the action in execution order"
+        },
+        "state": {
+          "$ref": "#/$defs/DebugState",
+          "description": "Current debug state"
+        },
+        "pauseReason": {
+          "oneOf": [
+            {"$ref": "#/$defs/PauseReason"},
+            {"type": "null"}
+          ],
+          "description": "Reason for pause if state is paused"
+        },
+        "result": {
+          "type": ["object", "null"],
+          "description": "Action execution result if available"
+        },
+        "error": {
+          "type": ["string", "null"],
+          "description": "Error message if action failed"
+        },
+        "variables": {
+          "type": ["object", "null"],
+          "description": "Current flow variables state"
+        }
+      },
+      "required": ["type", "sessionId", "state"]
+    }
+  }
+}

package/schemas/environment.json

@@ -0,0 +1,165 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://floweb.com/schemas/environment.json",
+  "title": "Environment and Global Variables Configuration",
+  "description": "Schema for environment configurations and global variables used in Floweb automation flows",
+  "type": "object",
+  "properties": {
+    "environments": {
+      "type": "array",
+      "description": "List of available environments",
+      "items": {
+        "$ref": "#/$defs/Environment"
+      },
+      "minItems": 0
+    },
+    "globalVariables": {
+      "type": "array",
+      "description": "List of global variables available across all environments",
+      "items": {
+        "$ref": "#/$defs/GlobalVariable"
+      },
+      "minItems": 0
+    },
+    "selectedEnvironmentId": {
+      "type": "string",
+      "description": "ID of the currently selected environment",
+      "pattern": "^[a-zA-Z0-9_-]+$"
+    }
+  },
+  "required": ["environments", "globalVariables"],
+  "$defs": {
+    "Environment": {
+      "type": "object",
+      "description": "An environment configuration with its variables",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier for the environment",
+          "pattern": "^[a-zA-Z0-9_-]+$",
+          "minLength": 1,
+          "maxLength": 50
+        },
+        "name": {
+          "type": "string",
+          "description": "Display name for the environment",
+          "minLength": 1,
+          "maxLength": 100
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the environment's purpose",
+          "maxLength": 500
+        },
+        "variables": {
+          "type": "array",
+          "description": "Environment-specific variables",
+          "items": {
+            "$ref": "#/$defs/Variable"
+          },
+          "minItems": 0
+        },
+        "isDefault": {
+          "type": "boolean",
+          "description": "Whether this is the default environment",
+          "default": false
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the environment was created"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the environment was last updated"
+        }
+      },
+      "required": ["id", "name", "variables", "isDefault"]
+    },
+    "GlobalVariable": {
+      "type": "object",
+      "description": "A global variable available across all environments",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier for the global variable",
+          "pattern": "^[a-zA-Z0-9_-]+$",
+          "minLength": 1,
+          "maxLength": 50
+        },
+        "name": {
+          "type": "string",
+          "description": "Variable name used in flows",
+          "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$",
+          "minLength": 1,
+          "maxLength": 50
+        },
+        "value": {
+          "type": "string",
+          "description": "The variable's value",
+          "minLength": 0,
+          "maxLength": 10000
+        },
+        "type": {
+          "type": "string",
+          "description": "Data type of the variable",
+          "enum": ["string", "number", "boolean", "url", "file", "json", "array"]
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the variable's purpose",
+          "maxLength": 500
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the variable was created"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the variable was last updated"
+        }
+      },
+      "required": ["id", "name", "value", "type"]
+    },
+    "Variable": {
+      "type": "object",
+      "description": "An environment-specific variable",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier for the variable within this environment",
+          "pattern": "^[a-zA-Z0-9_-]+$",
+          "minLength": 1,
+          "maxLength": 50
+        },
+        "name": {
+          "type": "string",
+          "description": "Variable name used in flows",
+          "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$",
+          "minLength": 1,
+          "maxLength": 50
+        },
+        "value": {
+          "type": "string",
+          "description": "The variable's value",
+          "minLength": 0,
+          "maxLength": 10000
+        },
+        "type": {
+          "type": "string",
+          "description": "Data type of the variable",
+          "enum": ["string", "number", "boolean", "url", "file", "json", "array"]
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the variable's purpose",
+          "maxLength": 500
+        }
+      },
+      "required": ["id", "name", "value", "type"]
+    }
+  }
+}

package/schemas/execution-results.json

@@ -0,0 +1,209 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://floweb.com/schemas/execution-results.json",
+  "title": "Execution Results Models",
+  "description": "Schema for action execution results and flow reports",
+  "type": "object",
+  "properties": {
+    "executionResults": {
+      "type": "object",
+      "properties": {
+        "actionResults": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ActionResult"
+          }
+        },
+        "flowReports": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/FlowReport"
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "ActionResult": {
+      "type": "object",
+      "description": "Result of executing an action",
+      "properties": {
+        "node_id": {
+          "type": "string",
+          "description": "Action node ID"
+        },
+        "action_type": {
+          "type": "string",
+          "description": "Type of action executed"
+        },
+        "config": {
+          "type": "object",
+          "description": "Action configuration used",
+          "additionalProperties": true
+        },
+        "start_time": {
+          "type": "integer",
+          "description": "Start timestamp in milliseconds"
+        },
+        "end_time": {
+          "type": "integer",
+          "description": "End timestamp in milliseconds"
+        },
+        "duration_seconds": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Duration in seconds"
+        },
+        "success": {
+          "type": "boolean",
+          "description": "Whether the action succeeded"
+        },
+        "message": {
+          "type": "string",
+          "description": "Result message"
+        },
+        "error": {
+          "type": "string",
+          "description": "Error message if failed"
+        },
+        "screenshot": {
+          "type": "string",
+          "description": "Base64 screenshot if taken"
+        },
+        "data": {
+          "type": "object",
+          "description": "Additional action-specific data",
+          "additionalProperties": true
+        }
+      },
+      "required": ["node_id", "action_type", "config", "start_time", "end_time", "duration_seconds", "success", "message"]
+    },
+    "FlowReport": {
+      "type": "object",
+      "description": "Complete report of flow execution",
+      "properties": {
+        "actions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ActionResult"
+          },
+          "description": "Results of all actions"
+        },
+        "variables": {
+          "type": "object",
+          "description": "Variables used during execution (input/output)",
+          "patternProperties": {
+            ".*": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": true
+              }
+            }
+          }
+        },
+        "parameters": {
+          "type": "object",
+          "description": "Parameters used during execution (input/output)",
+          "properties": {
+            "input": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": true
+              },
+              "default": []
+            },
+            "output": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": true
+              },
+              "default": []
+            }
+          },
+          "default": {
+            "input": [],
+            "output": []
+          }
+        },
+        "output": {
+          "type": "object",
+          "description": "Final output",
+          "additionalProperties": true,
+          "default": {}
+        },
+        "recording": {
+          "type": "string",
+          "description": "Recording data (deprecated, use recording_file instead)"
+        },
+        "recording_file": {
+          "type": "string",
+          "description": "Path to the recording file on the server"
+        },
+        "recording_duration": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Duration of the recording in seconds"
+        },
+        "flow_id": {
+          "type": "string",
+          "description": "ID of the executed flow"
+        },
+        "flow_name": {
+          "type": "string",
+          "description": "Name of the executed flow"
+        },
+        "start_time": {
+          "type": "integer",
+          "description": "Flow execution start timestamp"
+        },
+        "end_time": {
+          "type": "integer",
+          "description": "Flow execution end timestamp"
+        },
+        "total_duration": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Total execution time in seconds"
+        },
+        "success": {
+          "type": "boolean",
+          "description": "Overall flow success status"
+        },
+        "error": {
+          "type": "string",
+          "description": "Error message if flow failed"
+        },
+        "environment": {
+          "type": "object",
+          "description": "Environment used during execution",
+          "additionalProperties": true
+        },
+        "browser_info": {
+          "type": "object",
+          "description": "Browser information",
+          "properties": {
+            "name": {"type": "string"},
+            "version": {"type": "string"},
+            "user_agent": {"type": "string"}
+          }
+        },
+        "performance_metrics": {
+          "type": "object",
+          "description": "Performance metrics collected during execution",
+          "properties": {
+            "total_actions": {"type": "integer", "minimum": 0},
+            "successful_actions": {"type": "integer", "minimum": 0},
+            "failed_actions": {"type": "integer", "minimum": 0},
+            "average_action_time": {"type": "number", "minimum": 0},
+            "total_network_requests": {"type": "integer", "minimum": 0},
+            "total_data_transferred": {"type": "integer", "minimum": 0}
+          }
+        }
+      },
+      "required": ["actions", "variables", "parameters", "output"]
+    }
+  }
+}