griptape-nodes 0.51.1__py3-none-any.whl → 0.52.0__py3-none-any.whl

griptape_nodes/retained_mode/events/base_events.py

@@ -7,7 +7,6 @@ from dataclasses import asdict, dataclass, field, is_dataclass
 from typing import TYPE_CHECKING, Any, ClassVar, Literal, TypeVar
 
 from griptape.artifacts import BaseArtifact
-from griptape.events import BaseEvent as GtBaseEvent
 from griptape.mixins.serializable_mixin import SerializableMixin
 from griptape.structures import Structure
 from griptape.tools import BaseTool
@@ -632,18 +631,24 @@ class AppEvent[A: AppPayload](BaseEvent):
         return cls(payload=event_payload, **event_data)
 
 
-@dataclass
-class GriptapeNodeEvent(GtBaseEvent):
+class GriptapeNodeEvent(BaseEvent):
     wrapped_event: EventResult
 
+    def get_request(self) -> Payload:
+        """Get the request from the wrapped event."""
+        return self.wrapped_event.get_request()
 
-@dataclass
-class ExecutionGriptapeNodeEvent(GtBaseEvent):
-    wrapped_event: ExecutionEvent = field()
+
+class ExecutionGriptapeNodeEvent(BaseEvent):
+    wrapped_event: ExecutionEvent
+
+    def get_request(self) -> Payload:
+        """Get the request from the wrapped event."""
+        return self.wrapped_event.get_request()
 
 
 @dataclass
-class ProgressEvent(GtBaseEvent):
+class ProgressEvent:
     value: Any = field()
     node_name: str = field()
     parameter_name: str = field()

griptape_nodes/retained_mode/events/execution_events.py

@@ -340,12 +340,6 @@ class NodeStartProcessEvent(ExecutionPayload):
     node_name: str
 
 
-@dataclass
-@PayloadRegistry.register
-class ResumeNodeProcessingEvent(ExecutionPayload):
-    node_name: str
-
-
 @dataclass
 @PayloadRegistry.register
 class NodeFinishProcessEvent(ExecutionPayload):

griptape_nodes/retained_mode/events/node_events.py

@@ -774,3 +774,41 @@ class SendNodeMessageResultFailure(ResultPayloadFailure):
     """
 
     response: Any = None
+
+
+@dataclass
+@PayloadRegistry.register
+class GetFlowForNodeRequest(RequestPayload):
+    """Get the flow name that contains a specific node.
+
+    Use when: Need to determine which flow a node belongs to for variable scoping,
+    flow-specific operations, or hierarchical lookups.
+
+    Args:
+        node_name: Name of the node to get the flow for
+
+    Results: GetFlowForNodeResultSuccess (with flow name) | GetFlowForNodeResultFailure (node not found)
+    """
+
+    node_name: str
+
+
+@dataclass
+@PayloadRegistry.register
+class GetFlowForNodeResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Flow for node retrieved successfully.
+
+    Args:
+        flow_name: Name of the flow that contains the node
+    """
+
+    flow_name: str
+
+
+@dataclass
+@PayloadRegistry.register
+class GetFlowForNodeResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Flow for node retrieval failed.
+
+    Common causes: node not found, node not assigned to any flow.
+    """

griptape_nodes/retained_mode/events/parameter_events.py

@@ -43,6 +43,7 @@ class AddParameterToNodeRequest(RequestPayload):
         is_user_defined: Whether this is a user-defined parameter (affects serialization)
         parent_container_name: Name of parent container if nested
         initial_setup: Skip setup work when loading from file
+        settable: Whether parameter can be set directly by the user or not
 
     Results: AddParameterToNodeResultSuccess (with parameter name) | AddParameterToNodeResultFailure
     """
@@ -63,6 +64,7 @@ class AddParameterToNodeRequest(RequestPayload):
     mode_allowed_property: bool = Field(default=True)
     mode_allowed_output: bool = Field(default=True)
     is_user_defined: bool = Field(default=True)
+    settable: bool = Field(default=True)
     parent_container_name: str | None = None
     # initial_setup prevents unnecessary work when we are loading a workflow from a file.
     initial_setup: bool = False
@@ -160,6 +162,10 @@ class SetParameterValueRequest(RequestPayload):
     initial_setup: bool = False
     # is_output is true when the value being saved is from an output value. Used when loading a workflow from a file.
     is_output: bool = False
+    # incoming_connection_source fields identify when this request comes from upstream node value passing during resolution
+    # Both must be None (manual/user request) or both must be set (incoming connection source request)
+    incoming_connection_source_node_name: str | None = None
+    incoming_connection_source_parameter_name: str | None = None
 
 
 @dataclass
@@ -221,6 +227,7 @@ class GetParameterDetailsResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuc
         tooltip_as_input/property/output: Mode-specific tooltips
         mode_allowed_input/property/output: Which modes are allowed
         is_user_defined: Whether this is a user-defined parameter
+        settable: Whether parameter can be set directly by the user or not (None for non-Parameters)
         ui_options: UI configuration options
     """
 
@@ -237,6 +244,7 @@ class GetParameterDetailsResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuc
     mode_allowed_property: bool
     mode_allowed_output: bool
     is_user_defined: bool
+    settable: bool | None
     ui_options: dict | None
 
 
@@ -268,6 +276,7 @@ class AlterParameterDetailsRequest(RequestPayload):
         mode_allowed_input: Whether parameter can be used as input
         mode_allowed_property: Whether parameter can be used as property
         mode_allowed_output: Whether parameter can be used as output
+        settable: Whether parameter can be set directly by the user or not
         ui_options: New UI configuration options
         traits: Set of parameter traits
         initial_setup: Skip setup work when loading from file
@@ -289,6 +298,7 @@ class AlterParameterDetailsRequest(RequestPayload):
     mode_allowed_input: bool | None = None
     mode_allowed_property: bool | None = None
     mode_allowed_output: bool | None = None
+    settable: bool | None = None
     ui_options: dict | None = None
     traits: set[str] | None = None
     # initial_setup prevents unnecessary work when we are loading a workflow from a file.
@@ -326,6 +336,7 @@ class AlterParameterDetailsRequest(RequestPayload):
             "mode_allowed_input",
             "mode_allowed_property",
             "mode_allowed_output",
+            "settable",
             "ui_options",
             "traits",
         ]

griptape_nodes/retained_mode/events/variable_events.py

@@ -0,0 +1,361 @@
+from dataclasses import dataclass
+from typing import Any
+
+from griptape_nodes.retained_mode.events.base_events import (
+    RequestPayload,
+    ResultPayloadFailure,
+    ResultPayloadSuccess,
+    WorkflowAlteredMixin,
+    WorkflowNotAlteredMixin,
+)
+from griptape_nodes.retained_mode.events.payload_registry import PayloadRegistry
+from griptape_nodes.retained_mode.variable_types import FlowVariable, VariableScope
+
+
+# Variable Events
+@dataclass
+@PayloadRegistry.register
+class CreateVariableRequest(RequestPayload):
+    """Create a new variable.
+
+    Args:
+        name: The name of the variable
+        type: The user-defined type (e.g., "JSON", "str", "int")
+        is_global: Whether this is a global variable (True) or current flow variable (False)
+        value: The initial value of the variable
+        owning_flow: Flow that should own this variable (None for current flow in the Context Manager)
+    """
+
+    name: str
+    type: str
+    is_global: bool = False
+    value: Any = None
+    owning_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class CreateVariableResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Variable created successfully."""
+
+
+@dataclass
+@PayloadRegistry.register
+class CreateVariableResultFailure(WorkflowAlteredMixin, ResultPayloadFailure):
+    """Variable creation failed."""
+
+
+# Get Variable Events
+@dataclass
+@PayloadRegistry.register
+class GetVariableRequest(RequestPayload):
+    """Get a complete variable by name.
+
+    Args:
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Variable retrieved successfully."""
+
+    variable: FlowVariable
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Variable retrieval failed."""
+
+
+# Get Variable Value Events
+@dataclass
+@PayloadRegistry.register
+class GetVariableValueRequest(RequestPayload):
+    """Get the value of a variable by name.
+
+    Args:
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableValueResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Variable value retrieved successfully."""
+
+    value: Any
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableValueResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Variable value retrieval failed."""
+
+
+# Set Variable Value Events
+@dataclass
+@PayloadRegistry.register
+class SetVariableValueRequest(RequestPayload):
+    """Set the value of a variable by name.
+
+    Args:
+        value: The new value to set
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    value: Any
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class SetVariableValueResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Variable value set successfully."""
+
+
+@dataclass
+@PayloadRegistry.register
+class SetVariableValueResultFailure(WorkflowAlteredMixin, ResultPayloadFailure):
+    """Variable value setting failed."""
+
+
+# Get Variable Type Events
+@dataclass
+@PayloadRegistry.register
+class GetVariableTypeRequest(RequestPayload):
+    """Get the type of a variable by name.
+
+    Args:
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableTypeResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Variable type retrieved successfully."""
+
+    type: str
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableTypeResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Variable type retrieval failed."""
+
+
+# Set Variable Type Events
+@dataclass
+@PayloadRegistry.register
+class SetVariableTypeRequest(RequestPayload):
+    """Set the type of a variable by name.
+
+    Args:
+        type: The new user-defined type (e.g., "JSON", "str", "int")
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    type: str
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class SetVariableTypeResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Variable type set successfully."""
+
+
+@dataclass
+@PayloadRegistry.register
+class SetVariableTypeResultFailure(WorkflowAlteredMixin, ResultPayloadFailure):
+    """Variable type setting failed."""
+
+
+# Delete Variable Events
+@dataclass
+@PayloadRegistry.register
+class DeleteVariableRequest(RequestPayload):
+    """Delete a variable by name.
+
+    Args:
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class DeleteVariableResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Variable deleted successfully."""
+
+
+@dataclass
+@PayloadRegistry.register
+class DeleteVariableResultFailure(WorkflowAlteredMixin, ResultPayloadFailure):
+    """Variable deletion failed."""
+
+
+# Rename Variable Events
+@dataclass
+@PayloadRegistry.register
+class RenameVariableRequest(RequestPayload):
+    """Rename a variable by name.
+
+    Args:
+        new_name: The new name for the variable
+        name: Current variable name
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    new_name: str
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class RenameVariableResultSuccess(WorkflowAlteredMixin, ResultPayloadSuccess):
+    """Variable renamed successfully."""
+
+
+@dataclass
+@PayloadRegistry.register
+class RenameVariableResultFailure(WorkflowAlteredMixin, ResultPayloadFailure):
+    """Variable renaming failed."""
+
+
+# Has Variable Events
+@dataclass
+@PayloadRegistry.register
+class HasVariableRequest(RequestPayload):
+    """Check if a variable exists by name.
+
+    Args:
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class HasVariableResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Variable existence check completed."""
+
+    exists: bool
+    found_scope: VariableScope | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class HasVariableResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Variable existence check failed."""
+
+
+# List Variables Events
+@dataclass
+@PayloadRegistry.register
+class ListVariablesRequest(RequestPayload):
+    """List all variables in the specified scope.
+
+    Args:
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global; use ALL to get variables from all flows for GUI enumeration)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+@PayloadRegistry.register
+class ListVariablesResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Variables listed successfully."""
+
+    variables: list[FlowVariable]
+
+
+@dataclass
+@PayloadRegistry.register
+class ListVariablesResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Variables listing failed."""
+
+
+# Get Variable Details Events
+@dataclass
+@PayloadRegistry.register
+class GetVariableDetailsRequest(RequestPayload):
+    """Get variable details (metadata only, no heavy values).
+
+    Args:
+        name: Variable name to lookup
+        lookup_scope: Variable lookup strategy (default: hierarchical search through starting flow, ancestor flows, then global)
+        starting_flow: Starting flow name (None for current flow in the Context Manager)
+    """
+
+    name: str
+    lookup_scope: VariableScope = VariableScope.HIERARCHICAL
+    starting_flow: str | None = None
+
+
+@dataclass
+class VariableDetails:
+    """Lightweight variable details without heavy values."""
+
+    name: str
+    owning_flow_name: str | None  # None for global variables
+    type: str
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableDetailsResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Variable details retrieved successfully."""
+
+    details: VariableDetails
+
+
+@dataclass
+@PayloadRegistry.register
+class GetVariableDetailsResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Variable details retrieval failed."""

griptape_nodes/retained_mode/events/workflow_events.py

@@ -138,6 +138,41 @@ class RegisterWorkflowResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailur
     """Workflow registration failed. Common causes: invalid metadata, file not found, name conflict."""
 
 
+@dataclass
+@PayloadRegistry.register
+class ImportWorkflowRequest(RequestPayload):
+    """Import and register a workflow from a file.
+
+    Use when: Importing workflows from external sources, batch workflow imports,
+    command-line workflow registration, loading workflows from shared locations.
+
+    Args:
+        file_path: Path to the workflow file to import and register
+
+    Results: ImportWorkflowResultSuccess (with workflow name) | ImportWorkflowResultFailure (import error)
+    """
+
+    file_path: str
+
+
+@dataclass
+@PayloadRegistry.register
+class ImportWorkflowResultSuccess(WorkflowNotAlteredMixin, ResultPayloadSuccess):
+    """Workflow imported and registered successfully.
+
+    Args:
+        workflow_name: Name of the imported workflow
+    """
+
+    workflow_name: str
+
+
+@dataclass
+@PayloadRegistry.register
+class ImportWorkflowResultFailure(WorkflowNotAlteredMixin, ResultPayloadFailure):
+    """Workflow import failed. Common causes: file not found, invalid workflow format, metadata extraction error, registration error."""
+
+
 @dataclass
 @PayloadRegistry.register
 class ListAllWorkflowsRequest(RequestPayload):