griptape-nodes 0.60.4__py3-none-any.whl → 0.61.0__py3-none-any.whl

griptape_nodes/exe_types/param_types/parameter_video.py

@@ -0,0 +1,243 @@
+"""ParameterVideo component for video inputs with enhanced UI options."""
+
+from collections.abc import Callable
+from typing import Any
+
+from griptape_nodes.exe_types.core_types import Parameter, ParameterMode, Trait
+
+
+class ParameterVideo(Parameter):
+    """A specialized Parameter class for video inputs with enhanced UI options.
+
+    This class provides a convenient way to create video parameters with common
+    UI customizations like file browser, webcam capture, and video editing.
+    It exposes these UI options as direct properties for easy runtime modification.
+
+    Example:
+        param = ParameterVideo(
+            name="input_video",
+            tooltip="Select a video",
+            clickable_file_browser=True,
+            webcam_capture_video=True,
+            edit_video=True
+        )
+        param.pulse_on_run = True  # Change UI options at runtime
+    """
+
+    def __init__(  # noqa: PLR0913
+        self,
+        name: str,
+        tooltip: str | None = None,
+        *,
+        type: str = "VideoUrlArtifact",  # noqa: A002, ARG002
+        input_types: list[str] | None = None,  # noqa: ARG002
+        output_type: str = "VideoUrlArtifact",  # noqa: ARG002
+        default_value: Any = None,
+        tooltip_as_input: str | None = None,
+        tooltip_as_property: str | None = None,
+        tooltip_as_output: str | None = None,
+        allowed_modes: set[ParameterMode] | None = None,
+        traits: set[type[Trait] | Trait] | None = None,
+        converters: list[Callable[[Any], Any]] | None = None,
+        validators: list[Callable[[Parameter, Any], None]] | None = None,
+        ui_options: dict | None = None,
+        pulse_on_run: bool = False,
+        clickable_file_browser: bool = True,
+        webcam_capture_video: bool = False,
+        edit_video: bool = False,
+        accept_any: bool = True,
+        hide: bool = False,
+        hide_label: bool = False,
+        hide_property: bool = False,
+        allow_input: bool = True,
+        allow_property: bool = True,
+        allow_output: bool = True,
+        settable: bool = True,
+        serializable: bool = True,
+        user_defined: bool = False,
+        element_id: str | None = None,
+        element_type: str | None = None,
+        parent_container_name: str | None = None,
+    ) -> None:
+        """Initialize a video parameter with enhanced UI options.
+
+        Args:
+            name: Parameter name
+            tooltip: Parameter tooltip
+            type: Parameter type (ignored, always "VideoUrlArtifact" for ParameterVideo)
+            input_types: Allowed input types (ignored, set based on accept_any)
+            output_type: Output type (ignored, always "VideoUrlArtifact" for ParameterVideo)
+            default_value: Default parameter value
+            tooltip_as_input: Tooltip for input mode
+            tooltip_as_property: Tooltip for property mode
+            tooltip_as_output: Tooltip for output mode
+            allowed_modes: Allowed parameter modes
+            traits: Parameter traits
+            converters: Parameter converters
+            validators: Parameter validators
+            ui_options: Dictionary of UI options
+            pulse_on_run: Whether to pulse the parameter on run
+            clickable_file_browser: Whether to show clickable file browser
+            webcam_capture_video: Whether to enable webcam capture
+            edit_video: Whether to enable video editing functionality
+            accept_any: Whether to accept any input type and convert to video (default: True)
+            hide: Whether to hide the entire parameter
+            hide_label: Whether to hide the parameter label
+            hide_property: Whether to hide the parameter in property mode
+            allow_input: Whether to allow input mode
+            allow_property: Whether to allow property mode
+            allow_output: Whether to allow output mode
+            settable: Whether the parameter is settable
+            serializable: Whether the parameter is serializable
+            user_defined: Whether the parameter is user-defined
+            element_id: Element ID
+            element_type: Element type
+            parent_container_name: Name of parent container
+        """
+        # Build ui_options dictionary from the provided UI-specific parameters
+        if ui_options is None:
+            ui_options = {}
+        else:
+            ui_options = ui_options.copy()
+
+        # Add video-specific UI options if they have values
+        if pulse_on_run:
+            ui_options["pulse_on_run"] = pulse_on_run
+        if clickable_file_browser:
+            ui_options["clickable_file_browser"] = clickable_file_browser
+        if webcam_capture_video:
+            ui_options["webcam_capture_video"] = webcam_capture_video
+        if edit_video:
+            ui_options["edit_video"] = edit_video
+
+        # Auto-disable clickable_file_browser if neither input nor property modes are allowed
+        if not allow_input and not allow_property and clickable_file_browser:
+            ui_options.pop("clickable_file_browser", None)
+
+        # Set up input types based on accept_any setting
+        if accept_any:
+            final_input_types = ["any"]
+        else:
+            final_input_types = ["VideoUrlArtifact"]
+
+        # Call parent with explicit parameters, following ControlParameter pattern
+        super().__init__(
+            name=name,
+            tooltip=tooltip,
+            type="VideoUrlArtifact",  # Always a VideoUrlArtifact type for ParameterVideo
+            input_types=final_input_types,
+            output_type="VideoUrlArtifact",  # Always output as VideoUrlArtifact
+            default_value=default_value,
+            tooltip_as_input=tooltip_as_input,
+            tooltip_as_property=tooltip_as_property,
+            tooltip_as_output=tooltip_as_output,
+            allowed_modes=allowed_modes,
+            traits=traits,
+            converters=converters,
+            validators=validators,
+            ui_options=ui_options,
+            hide=hide,
+            hide_label=hide_label,
+            hide_property=hide_property,
+            allow_input=allow_input,
+            allow_property=allow_property,
+            allow_output=allow_output,
+            settable=settable,
+            serializable=serializable,
+            user_defined=user_defined,
+            element_id=element_id,
+            element_type=element_type,
+            parent_container_name=parent_container_name,
+        )
+
+    @property
+    def pulse_on_run(self) -> bool:
+        """Get whether pulse on run is enabled.
+
+        Returns:
+            True if pulse on run is enabled, False otherwise
+        """
+        return self.ui_options.get("pulse_on_run", False)
+
+    @pulse_on_run.setter
+    def pulse_on_run(self, value: bool) -> None:
+        """Set whether pulse on run is enabled.
+
+        Args:
+            value: Whether to enable pulse on run
+        """
+        if value:
+            self.update_ui_options_key("pulse_on_run", value)
+        else:
+            ui_options = self.ui_options.copy()
+            ui_options.pop("pulse_on_run", None)
+            self.ui_options = ui_options
+
+    @property
+    def clickable_file_browser(self) -> bool:
+        """Get whether clickable file browser is enabled.
+
+        Returns:
+            True if clickable file browser is enabled, False otherwise
+        """
+        return self.ui_options.get("clickable_file_browser", False)
+
+    @clickable_file_browser.setter
+    def clickable_file_browser(self, value: bool) -> None:
+        """Set whether clickable file browser is enabled.
+
+        Args:
+            value: Whether to enable clickable file browser
+        """
+        if value:
+            self.update_ui_options_key("clickable_file_browser", value)
+        else:
+            ui_options = self.ui_options.copy()
+            ui_options.pop("clickable_file_browser", None)
+            self.ui_options = ui_options
+
+    @property
+    def webcam_capture_video(self) -> bool:
+        """Get whether webcam capture video is enabled.
+
+        Returns:
+            True if webcam capture video is enabled, False otherwise
+        """
+        return self.ui_options.get("webcam_capture_video", False)
+
+    @webcam_capture_video.setter
+    def webcam_capture_video(self, value: bool) -> None:
+        """Set whether webcam capture video is enabled.
+
+        Args:
+            value: Whether to enable webcam capture video
+        """
+        if value:
+            self.update_ui_options_key("webcam_capture_video", value)
+        else:
+            ui_options = self.ui_options.copy()
+            ui_options.pop("webcam_capture_video", None)
+            self.ui_options = ui_options
+
+    @property
+    def edit_video(self) -> bool:
+        """Get whether edit video is enabled.
+
+        Returns:
+            True if edit video is enabled, False otherwise
+        """
+        return self.ui_options.get("edit_video", False)
+
+    @edit_video.setter
+    def edit_video(self, value: bool) -> None:
+        """Set whether edit video is enabled.
+
+        Args:
+            value: Whether to enable edit video
+        """
+        if value:
+            self.update_ui_options_key("edit_video", value)
+        else:
+            ui_options = self.ui_options.copy()
+            ui_options.pop("edit_video", None)
+            self.ui_options = ui_options

griptape_nodes/node_library/workflow_registry.py

@@ -45,7 +45,7 @@ class WorkflowShape(BaseModel):
 
 
 class WorkflowMetadata(BaseModel):
-    LATEST_SCHEMA_VERSION: ClassVar[str] = "0.10.0"
+    LATEST_SCHEMA_VERSION: ClassVar[str] = "0.11.0"
 
     name: str
     schema_version: str

griptape_nodes/retained_mode/events/execution_events.py

@@ -95,6 +95,47 @@ class StartFlowResultFailure(ResultPayloadFailure):
     validation_exceptions: list[Exception]
 
 
+@dataclass
+@PayloadRegistry.register
+class StartFlowFromNodeRequest(RequestPayload):
+    """Start executing a flow from a specific node.
+
+    Use when: Resuming execution from a particular node, debugging specific parts of a flow,
+    re-running portions of a workflow, implementing custom execution control.
+
+    Args:
+        flow_name: Name of the flow to start (deprecated)
+        node_name: Name of the node to start execution from
+        debug_mode: Whether to run in debug mode (default: False)
+        pickle_control_flow_result: If this is true, the final ControlFLowResolvedEvent will be pickled to be picked up from inside a subprocess
+
+    Results: StartFlowFromNodeResultSuccess | StartFlowFromNodeResultFailure (with validation exceptions)
+    """
+
+    flow_name: str | None = None
+    node_name: str | None = None
+    debug_mode: bool = False
+    pickle_control_flow_result: bool = False
+
+
+@dataclass
+@PayloadRegistry.register
+class StartFlowFromNodeResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Flow started from node successfully. Execution is now running from the specified node."""
+
+
+@dataclass
+@PayloadRegistry.register
+class StartFlowFromNodeResultFailure(ResultPayloadFailure):
+    """Flow start from node failed. Contains validation errors that prevented execution.
+
+    Args:
+        validation_exceptions: List of validation errors that occurred
+    """
+
+    validation_exceptions: list[Exception]
+
+
 @dataclass
 @PayloadRegistry.register
 class CancelFlowRequest(RequestPayload):

griptape_nodes/retained_mode/events/node_events.py

@@ -10,7 +10,11 @@ from griptape_nodes.exe_types.node_types import NodeResolutionState
 if TYPE_CHECKING:
     from griptape_nodes.exe_types.core_types import NodeMessagePayload
     from griptape_nodes.exe_types.node_types import NodeDependencies
-    from griptape_nodes.retained_mode.events.connection_events import ListConnectionsForNodeResultSuccess
+    from griptape_nodes.retained_mode.events.connection_events import (
+        IncomingConnection,
+        ListConnectionsForNodeResultSuccess,
+        OutgoingConnection,
+    )
     from griptape_nodes.retained_mode.events.parameter_events import (
         GetParameterDetailsResultSuccess,
         GetParameterValueResultSuccess,
@@ -819,3 +823,88 @@ class GetFlowForNodeResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure)
 
     Common causes: node not found, node not assigned to any flow.
     """
+
+
+@dataclass
+@PayloadRegistry.register
+class CanResetNodeToDefaultsRequest(RequestPayload):
+    """Check if a node can be reset to its default state.
+
+    Use when: Need to validate whether a node reset operation is allowed before attempting it,
+    implementing UI state (enabled/disabled reset button), or providing user feedback.
+    Checks for conditions that would prevent reset (locked state, missing metadata, etc.).
+
+    Args:
+        node_name: Name of the node to check (None for current context node)
+
+    Results: CanResetNodeToDefaultsResultSuccess (with can_reset flag and reason) | CanResetNodeToDefaultsResultFailure (validation failed)
+    """
+
+    node_name: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class CanResetNodeToDefaultsResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Node reset check completed successfully.
+
+    Args:
+        can_reset: True if the node can be reset to defaults, False otherwise
+        editor_tooltip_reason: Optional explanation if node cannot be reset (e.g., "Cannot reset locked node")
+    """
+
+    can_reset: bool
+    editor_tooltip_reason: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class CanResetNodeToDefaultsResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Node reset check failed.
+
+    Common causes: node not found, no current context, no library metadata.
+    """
+
+
+@dataclass
+@PayloadRegistry.register
+class ResetNodeToDefaultsRequest(RequestPayload):
+    """Reset a node to its default state while preserving connections where possible.
+
+    Use when: Need to reset a node's configuration back to defaults, clear customizations,
+    fix broken node state, or restore a node to its initial state. Creates a fresh instance
+    of the same node type and reconnects it to the workflow.
+
+    Args:
+        node_name: Name of the node to reset (None for current context node)
+
+    Results: ResetNodeToDefaultsResultSuccess (with reconnection status) | ResetNodeToDefaultsResultFailure (reset failed)
+    """
+
+    node_name: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class ResetNodeToDefaultsResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Node reset to defaults successfully.
+
+    Args:
+        node_name: Name of the reset node
+        failed_incoming_connections: List of incoming connections that failed to reconnect
+        failed_outgoing_connections: List of outgoing connections that failed to reconnect
+    """
+
+    node_name: str
+    failed_incoming_connections: list[IncomingConnection]
+    failed_outgoing_connections: list[OutgoingConnection]
+
+
+@dataclass
+@PayloadRegistry.register
+class ResetNodeToDefaultsResultFailure(ResultPayloadFailure):
+    """Node reset to defaults failed.
+
+    Common causes: node not found, no current context, failed to create new node,
+    failed to delete old node, failed to rename new node.
+    """

griptape_nodes/retained_mode/events/os_events.py

@@ -366,3 +366,111 @@ class WriteFileResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
     """
 
     failure_reason: FileIOFailureReason
+
+
+@dataclass
+@PayloadRegistry.register
+class CopyTreeRequest(RequestPayload):
+    """Copy an entire directory tree from source to destination.
+
+    Use when: Copying directories recursively, backing up directory structures,
+    duplicating folder hierarchies with all contents.
+
+    Args:
+        source_path: Path to the source directory to copy
+        destination_path: Path where the directory tree should be copied
+        symlinks: If True, copy symbolic links as links (default: False)
+        ignore_dangling_symlinks: If True, ignore dangling symlinks (default: False)
+        dirs_exist_ok: If True, allow destination to exist (default: False)
+        ignore_patterns: List of glob patterns to ignore (e.g., ["__pycache__", "*.pyc", ".git"])
+
+    Results: CopyTreeResultSuccess | CopyTreeResultFailure
+    """
+
+    source_path: str
+    destination_path: str
+    symlinks: bool = False
+    ignore_dangling_symlinks: bool = False
+    dirs_exist_ok: bool = False
+    ignore_patterns: list[str] | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class CopyTreeResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Directory tree copied successfully.
+
+    Attributes:
+        source_path: Source path that was copied
+        destination_path: Destination path where tree was copied
+        files_copied: Number of files copied
+        total_bytes_copied: Total bytes copied
+    """
+
+    source_path: str
+    destination_path: str
+    files_copied: int
+    total_bytes_copied: int
+
+
+@dataclass
+@PayloadRegistry.register
+class CopyTreeResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Directory tree copy failed.
+
+    Attributes:
+        failure_reason: Classification of why the copy failed
+        result_details: Human-readable error message (inherited from ResultPayloadFailure)
+    """
+
+    failure_reason: FileIOFailureReason
+
+
+@dataclass
+@PayloadRegistry.register
+class CopyFileRequest(RequestPayload):
+    """Copy a single file from source to destination.
+
+    Use when: Copying individual files, duplicating files,
+    backing up single files.
+
+    Args:
+        source_path: Path to the source file to copy
+        destination_path: Path where the file should be copied
+        overwrite: If True, overwrite destination if it exists (default: False)
+
+    Results: CopyFileResultSuccess | CopyFileResultFailure
+    """
+
+    source_path: str
+    destination_path: str
+    overwrite: bool = False
+
+
+@dataclass
+@PayloadRegistry.register
+class CopyFileResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """File copied successfully.
+
+    Attributes:
+        source_path: Source path that was copied
+        destination_path: Destination path where file was copied
+        bytes_copied: Number of bytes copied
+    """
+
+    source_path: str
+    destination_path: str
+    bytes_copied: int
+
+
+@dataclass
+@PayloadRegistry.register
+class CopyFileResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """File copy failed.
+
+    Attributes:
+        failure_reason: Classification of why the copy failed
+        result_details: Human-readable error message (inherited from ResultPayloadFailure)
+    """
+
+    failure_reason: FileIOFailureReason

griptape_nodes/retained_mode/events/parameter_events.py

@@ -161,7 +161,7 @@ class SetParameterValueRequest(RequestPayload):
     """
 
     parameter_name: str
-    value: Any
+    value: str | int | float | bool | dict | None
     # If node name is None, use the Current Context
     node_name: str | None = None
     data_type: str | None = None