@autoweb/domain-models 1.0.0

package/python-models/build/lib/floweb_models/debug.py

@@ -0,0 +1,209 @@
+# generated by datamodel-codegen:
+#   filename:  debug.json
+#   timestamp: 2026-02-04T15:36:47+00:00
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DebugModels(BaseModel):
+    """
+    Schema for debug session management, states, and execution control
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+
+
+class DebugState(StrEnum):
+    """
+    Debug session states following the state machine specification
+    """
+
+    ready = 'ready'
+    running = 'running'
+    paused = 'paused'
+    stepping = 'stepping'
+    completed = 'completed'
+    error = 'error'
+    stopped = 'stopped'
+
+
+class PauseReason(StrEnum):
+    """
+    Reasons for debug execution pause
+    """
+
+    breakpoint = 'breakpoint'
+    manual = 'manual'
+    error = 'error'
+    step = 'step'
+
+
+class Breakpoint(BaseModel):
+    """
+    Represents a breakpoint in debug execution
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    nodeId: str
+    """
+    Action/node ID where breakpoint is set
+    """
+    enabled: bool
+    """
+    Whether the breakpoint is active
+    """
+    hitCount: int | None = 0
+    """
+    Number of times this breakpoint has been hit
+    """
+
+
+class DebugExecutionInfo(BaseModel):
+    """
+    Information about current debug execution state
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    currentNodeId: str | None
+    """
+    ID of the action currently being executed or about to execute
+    """
+    currentActionIndex: int
+    """
+    Zero-based index of current action in execution order
+    """
+    totalActions: int
+    """
+    Total number of actions in the flow
+    """
+    executedActions: list[str]
+    """
+    List of action IDs that have been executed
+    """
+    nextBreakpoint: str | None
+    """
+    ID of the next breakpoint that will be hit
+    """
+
+
+class DebugSession(BaseModel):
+    """
+    Represents a single debug execution session
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    sessionId: str
+    """
+    Unique identifier for the debug session
+    """
+    flowId: str
+    """
+    ID of the flow being debugged
+    """
+    breakpoints: list[str]
+    """
+    Set of action IDs where execution should pause
+    """
+    state: DebugState
+    currentActionId: str | None = None
+    """
+    ID of the action currently being executed or about to execute
+    """
+    currentActionIndex: int | None = 0
+    """
+    Zero-based index of current action in execution order
+    """
+    executedActions: list[str] | None = []
+    """
+    List of action IDs that have been executed
+    """
+    pauseRequested: bool | None = False
+    """
+    Flag indicating manual pause was requested
+    """
+    stopRequested: bool | None = False
+    """
+    Flag indicating stop was requested
+    """
+    createdAt: float | None = None
+    """
+    Timestamp when session was created (Unix timestamp)
+    """
+    lastUpdated: float | None = None
+    """
+    Timestamp of last state change (Unix timestamp)
+    """
+
+
+class Type(StrEnum):
+    """
+    Type of debug update
+    """
+
+    debug_action_started = 'debug_action_started'
+    debug_action_completed = 'debug_action_completed'
+    debug_action_failed = 'debug_action_failed'
+    debug_paused = 'debug_paused'
+    debug_resumed = 'debug_resumed'
+    debug_completed = 'debug_completed'
+    debug_stopped = 'debug_stopped'
+    debug_error = 'debug_error'
+
+
+class DebugActionUpdate(BaseModel):
+    """
+    Real-time update sent during debug execution
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    type: Type
+    """
+    Type of debug update
+    """
+    sessionId: str
+    """
+    Debug session ID
+    """
+    actionId: str | None = None
+    """
+    Action ID related to this update
+    """
+    actionIndex: int | None = None
+    """
+    Index of the action in execution order
+    """
+    state: DebugState
+    """
+    Current debug state
+    """
+    pauseReason: PauseReason | None = None
+    """
+    Reason for pause if state is paused
+    """
+    result: dict[str, Any] | None = None
+    """
+    Action execution result if available
+    """
+    error: str | None = None
+    """
+    Error message if action failed
+    """
+    variables: dict[str, Any] | None = None
+    """
+    Current flow variables state
+    """

package/python-models/build/lib/floweb_models/debug_models.py

@@ -0,0 +1,141 @@
+"""Debug-related domain models shared by backend and frontend contracts."""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Any, Literal
+
+from pydantic import BaseModel, ConfigDict
+
+
+class DebugState(StrEnum):
+    """Current debug execution state."""
+
+    ready = "ready"
+    running = "running"
+    paused = "paused"
+    stepping = "stepping"
+    completed = "completed"
+    failed = "failed"
+    stopped = "stopped"
+
+
+class PauseReason(StrEnum):
+    """Reason debug execution paused."""
+
+    breakpoint = "breakpoint"
+    manual = "manual"
+    step = "step"
+    error = "error"
+
+
+class Breakpoint(BaseModel):
+    """Breakpoint configuration for a flow node."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    node_id: str
+    enabled: bool = True
+
+
+class DebugExecutionInfo(BaseModel):
+    """Runtime debug execution snapshot."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    session_id: str
+    flow_id: str
+    state: DebugState
+    current_action_id: str | None = None
+    current_action_index: int = 0
+    executed_actions: list[str] | None = None
+
+
+class DebugSession(BaseModel):
+    """Debug session metadata and state."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    session_id: str
+    flow_id: str
+    state: DebugState = DebugState.ready
+    breakpoints: list[str] | None = None
+    current_action_id: str | None = None
+    current_action_index: int = 0
+    created_at: float | None = None
+    last_updated: float | None = None
+
+
+class DebugActionUpdate(BaseModel):
+    """Incremental debug action status update."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    session_id: str
+    node_id: str
+    action_index: int
+    action_type: str | None = None
+    status: Literal["started", "completed", "failed", "skipped"]
+    result: dict[str, Any] | None = None
+
+
+class DebugRunCommand(BaseModel):
+    """Start debug execution for a flow."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    command: Literal["debug_run"] = "debug_run"
+    session_id: str
+    flow: dict[str, Any]
+    breakpoints: list[str] | None = None
+    browser: str | None = None
+    headless: bool = False
+    incognito: bool = False
+
+
+class DebugStepCommand(BaseModel):
+    """Execute one action and pause again."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    command: Literal["debug_step"] = "debug_step"
+    session_id: str
+
+
+class DebugContinueCommand(BaseModel):
+    """Continue execution until next pause condition."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    command: Literal["debug_continue"] = "debug_continue"
+    session_id: str
+
+
+class DebugPauseCommand(BaseModel):
+    """Request pause for a running debug session."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    command: Literal["debug_pause"] = "debug_pause"
+    session_id: str
+
+
+class DebugStopCommand(BaseModel):
+    """Stop a running debug session."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    command: Literal["debug_stop"] = "debug_stop"
+    session_id: str
+
+
+class DebugResponse(BaseModel):
+    """Generic debug websocket response model."""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    command: str
+    success: bool
+    session_id: str | None = None
+    message: str | None = None
+    data: dict[str, Any] | None = None

package/python-models/build/lib/floweb_models/environment.py

@@ -0,0 +1,158 @@
+# generated by datamodel-codegen:
+#   filename:  environment.json
+#   timestamp: 2026-01-25T13:38:24+00:00
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Annotated
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class Type(StrEnum):
+    """
+    Data type of the variable
+    """
+
+    string = 'string'
+    number = 'number'
+    boolean = 'boolean'
+    url = 'url'
+    file = 'file'
+    json = 'json'
+    array = 'array'
+
+
+class GlobalVariable(BaseModel):
+    """
+    A global variable available across all environments
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    id: Annotated[str, Field(max_length=50, min_length=1, pattern='^[a-zA-Z0-9_-]+$')]
+    """
+    Unique identifier for the global variable
+    """
+    name: Annotated[
+        str, Field(max_length=50, min_length=1, pattern='^[a-zA-Z_][a-zA-Z0-9_]*$')
+    ]
+    """
+    Variable name used in flows
+    """
+    value: Annotated[str, Field(max_length=10000, min_length=0)]
+    """
+    The variable's value
+    """
+    type: Type
+    """
+    Data type of the variable
+    """
+    description: Annotated[str | None, Field(max_length=500)] = None
+    """
+    Description of the variable's purpose
+    """
+    createdAt: AwareDatetime
+    """
+    ISO 8601 timestamp when the variable was created
+    """
+    updatedAt: AwareDatetime
+    """
+    ISO 8601 timestamp when the variable was last updated
+    """
+
+
+class Variable(BaseModel):
+    """
+    An environment-specific variable
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    id: Annotated[str, Field(max_length=50, min_length=1, pattern='^[a-zA-Z0-9_-]+$')]
+    """
+    Unique identifier for the variable within this environment
+    """
+    name: Annotated[
+        str, Field(max_length=50, min_length=1, pattern='^[a-zA-Z_][a-zA-Z0-9_]*$')
+    ]
+    """
+    Variable name used in flows
+    """
+    value: Annotated[str, Field(max_length=10000, min_length=0)]
+    """
+    The variable's value
+    """
+    type: Type
+    """
+    Data type of the variable
+    """
+    description: Annotated[str | None, Field(max_length=500)] = None
+    """
+    Description of the variable's purpose
+    """
+
+
+class Environment(BaseModel):
+    """
+    An environment configuration with its variables
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    id: Annotated[str, Field(max_length=50, min_length=1, pattern='^[a-zA-Z0-9_-]+$')]
+    """
+    Unique identifier for the environment
+    """
+    name: Annotated[str, Field(max_length=100, min_length=1)]
+    """
+    Display name for the environment
+    """
+    description: Annotated[str | None, Field(max_length=500)] = None
+    """
+    Description of the environment's purpose
+    """
+    variables: Annotated[list[Variable], Field(min_length=0)]
+    """
+    Environment-specific variables
+    """
+    isDefault: bool
+    """
+    Whether this is the default environment
+    """
+    createdAt: AwareDatetime
+    """
+    ISO 8601 timestamp when the environment was created
+    """
+    updatedAt: AwareDatetime
+    """
+    ISO 8601 timestamp when the environment was last updated
+    """
+
+
+class EnvironmentAndGlobalVariablesConfiguration(BaseModel):
+    """
+    Schema for environment configurations and global variables used in Floweb automation flows
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    environments: Annotated[list[Environment], Field(min_length=0)]
+    """
+    List of available environments
+    """
+    globalVariables: Annotated[list[GlobalVariable], Field(min_length=0)]
+    """
+    List of global variables available across all environments
+    """
+    selectedEnvironmentId: Annotated[str | None, Field(pattern='^[a-zA-Z0-9_-]+$')] = (
+        None
+    )
+    """
+    ID of the currently selected environment
+    """

package/python-models/build/lib/floweb_models/execution_results.py

@@ -0,0 +1,208 @@
+# generated by datamodel-codegen:
+#   filename:  execution-results.json
+#   timestamp: 2026-01-25T13:38:26+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ActionResult(BaseModel):
+    """
+    Result of executing an action
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    node_id: str
+    """
+    Action node ID
+    """
+    action_type: str
+    """
+    Type of action executed
+    """
+    config: dict[str, Any]
+    """
+    Action configuration used
+    """
+    start_time: int
+    """
+    Start timestamp in milliseconds
+    """
+    end_time: int
+    """
+    End timestamp in milliseconds
+    """
+    duration_seconds: Annotated[float, Field(ge=0.0)]
+    """
+    Duration in seconds
+    """
+    success: bool
+    """
+    Whether the action succeeded
+    """
+    message: str
+    """
+    Result message
+    """
+    error: str | None = None
+    """
+    Error message if failed
+    """
+    screenshot: str | None = None
+    """
+    Base64 screenshot if taken
+    """
+    data: dict[str, Any] | None = None
+    """
+    Additional action-specific data
+    """
+
+
+class Parameters(BaseModel):
+    """
+    Parameters used during execution (input/output)
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    input: list[dict[str, Any]] | None = []
+    output: list[dict[str, Any]] | None = []
+
+
+class BrowserInfo(BaseModel):
+    """
+    Browser information
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    name: str | None = None
+    version: str | None = None
+    user_agent: str | None = None
+
+
+class PerformanceMetrics(BaseModel):
+    """
+    Performance metrics collected during execution
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    total_actions: Annotated[int | None, Field(ge=0)] = None
+    successful_actions: Annotated[int | None, Field(ge=0)] = None
+    failed_actions: Annotated[int | None, Field(ge=0)] = None
+    average_action_time: Annotated[float | None, Field(ge=0.0)] = None
+    total_network_requests: Annotated[int | None, Field(ge=0)] = None
+    total_data_transferred: Annotated[int | None, Field(ge=0)] = None
+
+
+class FlowReport(BaseModel):
+    """
+    Complete report of flow execution
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    actions: list[ActionResult]
+    """
+    Results of all actions
+    """
+    variables: dict[str, list[dict[str, Any]]]
+    """
+    Variables used during execution (input/output)
+    """
+    parameters: Annotated[
+        Parameters,
+        Field(
+            default_factory=lambda: Parameters.model_validate(
+                {'input': [], 'output': []}
+            )
+        ),
+    ]
+    """
+    Parameters used during execution (input/output)
+    """
+    output: dict[str, Any]
+    """
+    Final output
+    """
+    recording: str | None = None
+    """
+    Recording data (deprecated, use recording_file instead)
+    """
+    recording_file: str | None = None
+    """
+    Path to the recording file on the server
+    """
+    recording_duration: Annotated[float | None, Field(ge=0.0)] = None
+    """
+    Duration of the recording in seconds
+    """
+    flow_id: str | None = None
+    """
+    ID of the executed flow
+    """
+    flow_name: str | None = None
+    """
+    Name of the executed flow
+    """
+    start_time: int | None = None
+    """
+    Flow execution start timestamp
+    """
+    end_time: int | None = None
+    """
+    Flow execution end timestamp
+    """
+    total_duration: Annotated[float | None, Field(ge=0.0)] = None
+    """
+    Total execution time in seconds
+    """
+    success: bool | None = None
+    """
+    Overall flow success status
+    """
+    error: str | None = None
+    """
+    Error message if flow failed
+    """
+    environment: dict[str, Any] | None = None
+    """
+    Environment used during execution
+    """
+    browser_info: BrowserInfo | None = None
+    """
+    Browser information
+    """
+    performance_metrics: PerformanceMetrics | None = None
+    """
+    Performance metrics collected during execution
+    """
+
+
+class ExecutionResults(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    actionResults: list[ActionResult] | None = None
+    flowReports: list[FlowReport] | None = None
+
+
+class ExecutionResultsModels(BaseModel):
+    """
+    Schema for action execution results and flow reports
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    executionResults: ExecutionResults | None = None