Source code for soulfire.script_connect

# Generated from soulfire/script.proto. DO NOT EDIT.
# Generated by protoc-gen-connectrpc-py v0.13.0 with parameter "protobuf=google".
# ruff: noqa: PGH004
# ruff: noqa
# pyright: reportDeprecated=false
# ty: ignore[unused-ignore-comment]
# ty: ignore[deprecated, unused-ignore-comment]
# fmt: off

from __future__ import annotations

from typing import Protocol, TYPE_CHECKING

from connectrpc.client import ConnectClient, ConnectClientSync
from connectrpc.code import Code
from connectrpc.compat import google_protobuf_binary_codec, google_protobuf_codecs
from connectrpc.compression.gzip import GzipCompression
from connectrpc.errors import ConnectError
from connectrpc.method import IdempotencyLevel, MethodInfo, StreamType
from connectrpc.protocol import ProtocolType
from connectrpc.server import ConnectASGIApplication, ConnectWSGIApplication, DEFAULT_READ_MAX_BYTES, Endpoint, EndpointSync
from pyqwest import Client, SyncClient

from .script_pb2 import ActivateScriptRequest, CreateScriptRequest, CreateScriptResponse, DeactivateScriptRequest, DeactivateScriptResponse, DeleteScriptRequest, DeleteScriptResponse, DryRunScriptRequest, GetNodeTypesRequest, GetNodeTypesResponse, GetRegistryDataRequest, GetRegistryDataResponse, GetScriptRequest, GetScriptResponse, GetScriptStatusRequest, GetScriptStatusResponse, ListScriptsRequest, ListScriptsResponse, ScriptEvent, ScriptLogEntry, SubscribeScriptLogsRequest, UpdateScriptRequest, UpdateScriptResponse, ValidateScriptRequest, ValidateScriptResponse

if TYPE_CHECKING:
    from collections.abc import AsyncGenerator, AsyncIterator, Iterable, Iterator, Mapping

    from connectrpc.codec import Codec
    from connectrpc.compression import Compression
    from connectrpc.interceptor import Interceptor, InterceptorSync
    from connectrpc.request import Headers, RequestContext



_DEFAULT_CODECS = google_protobuf_codecs()
_PROTO_BINARY_CODEC = google_protobuf_binary_codec()
_GZIP_COMPRESSION = GzipCompression()

[docs] class ScriptService(Protocol): """ ScriptService provides management and execution capabilities for visual node-based automation scripts within SoulFire. The visual scripting system allows users to create automation workflows by connecting nodes in a graph. Each node represents an action, condition, or event trigger. Nodes are connected by edges that define execution flow and data transfer. SCRIPT LIFECYCLE: 1. Create a script using CreateScript with initial nodes/edges or empty graph 2. Edit the script using UpdateScript to modify the node graph 3. Activate the script using ActivateScript to register event listeners 4. Monitor execution via SubscribeScriptEvents or GetScriptStatus 5. Deactivate using DeactivateScript when done 6. Delete unused scripts with DeleteScript Scripts are reactive state machines - they don't "run" but rather listen for trigger events and execute node chains in response. Activation registers the listeners, deactivation removes them and cancels any pending async operations. PERMISSIONS: Script operations require appropriate instance permissions. The specific permissions are TBD but will likely include: - READ_SCRIPT: View script definitions and status - UPDATE_SCRIPT: Create, modify, and delete scripts - EXECUTE_SCRIPT: Activate and deactivate scripts LOGGING: Script execution logs can be streamed via SubscribeScriptLogs or filtered using InstanceScriptLogScope in the LogsService (see logs.proto). """
[docs] async def create_script(self, request: CreateScriptRequest, ctx: RequestContext[CreateScriptRequest, CreateScriptResponse], /) -> CreateScriptResponse: """ Creates a new script in the specified instance. The script can be created with initial nodes and edges, or as a blank script to be edited later. Returns: The complete script data including the generated ID Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script creation permission Errors: INVALID_ARGUMENT if required fields are missing or invalid """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def get_script(self, request: GetScriptRequest, ctx: RequestContext[GetScriptRequest, GetScriptResponse], /) -> GetScriptResponse: """ Retrieves a specific script by its ID. Returns the complete script data including all nodes and edges. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def update_script(self, request: UpdateScriptRequest, ctx: RequestContext[UpdateScriptRequest, UpdateScriptResponse], /) -> UpdateScriptResponse: """ Updates an existing script's metadata and/or node graph. Only specified fields are updated; others remain unchanged. Use update_nodes/update_edges flags to explicitly set empty lists. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script update permission Errors: INVALID_ARGUMENT if update data is invalid """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def delete_script(self, request: DeleteScriptRequest, ctx: RequestContext[DeleteScriptRequest, DeleteScriptResponse], /) -> DeleteScriptResponse: """ Permanently deletes a script. If the script is currently active, it will be deactivated first. This operation cannot be undone. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script delete permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def list_scripts(self, request: ListScriptsRequest, ctx: RequestContext[ListScriptsRequest, ListScriptsResponse], /) -> ListScriptsResponse: """ Lists all scripts in the specified instance. Returns summary information (ScriptInfo) without full node/edge data to reduce response size. Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def activate_script(self, request: ActivateScriptRequest, ctx: RequestContext[ActivateScriptRequest, ScriptEvent], /) -> AsyncIterator[ScriptEvent]: """ Activates a script by registering its trigger event listeners. The script will begin responding to trigger events (tick, chat, etc.). Returns a stream of execution events as triggers fire and nodes execute. The stream remains open until the script is deactivated. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is already active Errors: INVALID_ARGUMENT if script graph is invalid (e.g., no trigger nodes) """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def deactivate_script(self, request: DeactivateScriptRequest, ctx: RequestContext[DeactivateScriptRequest, DeactivateScriptResponse], /) -> DeactivateScriptResponse: """ Deactivates an active script. Unregisters all event listeners and cancels any pending async operations. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is not active """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def get_script_status(self, request: GetScriptStatusRequest, ctx: RequestContext[GetScriptStatusRequest, GetScriptStatusResponse], /) -> GetScriptStatusResponse: """ Gets the current status of a script. Returns whether the script is active, which node is executing, and activation count. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def subscribe_script_logs(self, request: SubscribeScriptLogsRequest, ctx: RequestContext[SubscribeScriptLogsRequest, ScriptLogEntry], /) -> AsyncIterator[ScriptLogEntry]: """ Subscribes to log entries generated during script execution. Returns a stream of log entries at or above the specified minimum level. The stream remains open until cancelled by the client. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script log subscription permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def get_node_types(self, request: GetNodeTypesRequest, ctx: RequestContext[GetNodeTypesRequest, GetNodeTypesResponse], /) -> GetNodeTypesResponse: """ Gets all available node types with their metadata. This enables clients to render the node editor without hardcoded knowledge of specific node types. The response includes port definitions, categories, display names, and all other information needed to render and validate nodes. This endpoint is cacheable - node types only change between server versions. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def get_registry_data(self, request: GetRegistryDataRequest, ctx: RequestContext[GetRegistryDataRequest, GetRegistryDataResponse], /) -> GetRegistryDataResponse: """ Gets Minecraft registry data for autocomplete and validation. Returns blocks, entities, items, and biomes that can be used in scripts. This endpoint is cacheable - registry data only changes between server versions. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] async def validate_script(self, request: ValidateScriptRequest, ctx: RequestContext[ValidateScriptRequest, ValidateScriptResponse], /) -> ValidateScriptResponse: """ Validates a script graph without saving it. Returns all diagnostics (errors and warnings) for the given nodes and edges. Useful for live validation in the editor without requiring a save. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def dry_run_script(self, request: DryRunScriptRequest, ctx: RequestContext[DryRunScriptRequest, ScriptEvent], /) -> AsyncIterator[ScriptEvent]: """ Dry-runs a script from a specified trigger with mock inputs. Executes the graph without requiring an active instance. Returns execution events as a stream for the editor to display. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] class ScriptServiceASGIApplication(ConnectASGIApplication[ScriptService]): def __init__( self, service: ScriptService | AsyncGenerator[ScriptService], *, interceptors: Iterable[Interceptor] = (), read_max_bytes: int | None = DEFAULT_READ_MAX_BYTES, compressions: Iterable[Compression] | None = None, codecs: Iterable[Codec] | None = _DEFAULT_CODECS, ) -> None: super().__init__( service=service, endpoints=lambda svc: { "/soulfire.v1.ScriptService/CreateScript": Endpoint.unary( method=MethodInfo( name="CreateScript", service_name="soulfire.v1.ScriptService", input=CreateScriptRequest, output=CreateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.create_script, ), "/soulfire.v1.ScriptService/GetScript": Endpoint.unary( method=MethodInfo( name="GetScript", service_name="soulfire.v1.ScriptService", input=GetScriptRequest, output=GetScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.get_script, ), "/soulfire.v1.ScriptService/UpdateScript": Endpoint.unary( method=MethodInfo( name="UpdateScript", service_name="soulfire.v1.ScriptService", input=UpdateScriptRequest, output=UpdateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.update_script, ), "/soulfire.v1.ScriptService/DeleteScript": Endpoint.unary( method=MethodInfo( name="DeleteScript", service_name="soulfire.v1.ScriptService", input=DeleteScriptRequest, output=DeleteScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.delete_script, ), "/soulfire.v1.ScriptService/ListScripts": Endpoint.unary( method=MethodInfo( name="ListScripts", service_name="soulfire.v1.ScriptService", input=ListScriptsRequest, output=ListScriptsResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.list_scripts, ), "/soulfire.v1.ScriptService/ActivateScript": Endpoint.server_stream( method=MethodInfo( name="ActivateScript", service_name="soulfire.v1.ScriptService", input=ActivateScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), function=svc.activate_script, ), "/soulfire.v1.ScriptService/DeactivateScript": Endpoint.unary( method=MethodInfo( name="DeactivateScript", service_name="soulfire.v1.ScriptService", input=DeactivateScriptRequest, output=DeactivateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.deactivate_script, ), "/soulfire.v1.ScriptService/GetScriptStatus": Endpoint.unary( method=MethodInfo( name="GetScriptStatus", service_name="soulfire.v1.ScriptService", input=GetScriptStatusRequest, output=GetScriptStatusResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.get_script_status, ), "/soulfire.v1.ScriptService/SubscribeScriptLogs": Endpoint.server_stream( method=MethodInfo( name="SubscribeScriptLogs", service_name="soulfire.v1.ScriptService", input=SubscribeScriptLogsRequest, output=ScriptLogEntry, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), function=svc.subscribe_script_logs, ), "/soulfire.v1.ScriptService/GetNodeTypes": Endpoint.unary( method=MethodInfo( name="GetNodeTypes", service_name="soulfire.v1.ScriptService", input=GetNodeTypesRequest, output=GetNodeTypesResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.get_node_types, ), "/soulfire.v1.ScriptService/GetRegistryData": Endpoint.unary( method=MethodInfo( name="GetRegistryData", service_name="soulfire.v1.ScriptService", input=GetRegistryDataRequest, output=GetRegistryDataResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.get_registry_data, ), "/soulfire.v1.ScriptService/ValidateScript": Endpoint.unary( method=MethodInfo( name="ValidateScript", service_name="soulfire.v1.ScriptService", input=ValidateScriptRequest, output=ValidateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=svc.validate_script, ), "/soulfire.v1.ScriptService/DryRunScript": Endpoint.server_stream( method=MethodInfo( name="DryRunScript", service_name="soulfire.v1.ScriptService", input=DryRunScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), function=svc.dry_run_script, ), }, interceptors=interceptors, read_max_bytes=read_max_bytes, compressions=compressions, codecs=codecs, ) @property def path(self) -> str: """Returns the URL path to mount the application to when serving multiple applications.""" return "/soulfire.v1.ScriptService"
[docs] class ScriptServiceClient(ConnectClient): """ ScriptService provides management and execution capabilities for visual node-based automation scripts within SoulFire. The visual scripting system allows users to create automation workflows by connecting nodes in a graph. Each node represents an action, condition, or event trigger. Nodes are connected by edges that define execution flow and data transfer. SCRIPT LIFECYCLE: 1. Create a script using CreateScript with initial nodes/edges or empty graph 2. Edit the script using UpdateScript to modify the node graph 3. Activate the script using ActivateScript to register event listeners 4. Monitor execution via SubscribeScriptEvents or GetScriptStatus 5. Deactivate using DeactivateScript when done 6. Delete unused scripts with DeleteScript Scripts are reactive state machines - they don't "run" but rather listen for trigger events and execute node chains in response. Activation registers the listeners, deactivation removes them and cancels any pending async operations. PERMISSIONS: Script operations require appropriate instance permissions. The specific permissions are TBD but will likely include: - READ_SCRIPT: View script definitions and status - UPDATE_SCRIPT: Create, modify, and delete scripts - EXECUTE_SCRIPT: Activate and deactivate scripts LOGGING: Script execution logs can be streamed via SubscribeScriptLogs or filtered using InstanceScriptLogScope in the LogsService (see logs.proto). """ def __init__( self, address: str, *, codec: Codec | None = _PROTO_BINARY_CODEC, protocol: ProtocolType = ProtocolType.CONNECT, accept_compression: Iterable[Compression] | None = None, send_compression: Compression | None = _GZIP_COMPRESSION, timeout_ms: int | None = None, read_max_bytes: int | None = None, interceptors: Iterable[Interceptor] = (), http_client: Client | None = None, ) -> None: super().__init__( address=address, codec=codec, protocol=protocol, accept_compression=accept_compression, send_compression=send_compression, timeout_ms=timeout_ms, read_max_bytes=read_max_bytes, interceptors=interceptors, http_client=http_client, )
[docs] async def create_script( self, request: CreateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> CreateScriptResponse: """ Creates a new script in the specified instance. The script can be created with initial nodes and edges, or as a blank script to be edited later. Returns: The complete script data including the generated ID Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script creation permission Errors: INVALID_ARGUMENT if required fields are missing or invalid """ return await self.execute_unary( request=request, method=MethodInfo( name="CreateScript", service_name="soulfire.v1.ScriptService", input=CreateScriptRequest, output=CreateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def get_script( self, request: GetScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetScriptResponse: """ Retrieves a specific script by its ID. Returns the complete script data including all nodes and edges. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ return await self.execute_unary( request=request, method=MethodInfo( name="GetScript", service_name="soulfire.v1.ScriptService", input=GetScriptRequest, output=GetScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def update_script( self, request: UpdateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> UpdateScriptResponse: """ Updates an existing script's metadata and/or node graph. Only specified fields are updated; others remain unchanged. Use update_nodes/update_edges flags to explicitly set empty lists. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script update permission Errors: INVALID_ARGUMENT if update data is invalid """ return await self.execute_unary( request=request, method=MethodInfo( name="UpdateScript", service_name="soulfire.v1.ScriptService", input=UpdateScriptRequest, output=UpdateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def delete_script( self, request: DeleteScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> DeleteScriptResponse: """ Permanently deletes a script. If the script is currently active, it will be deactivated first. This operation cannot be undone. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script delete permission """ return await self.execute_unary( request=request, method=MethodInfo( name="DeleteScript", service_name="soulfire.v1.ScriptService", input=DeleteScriptRequest, output=DeleteScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def list_scripts( self, request: ListScriptsRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> ListScriptsResponse: """ Lists all scripts in the specified instance. Returns summary information (ScriptInfo) without full node/edge data to reduce response size. Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ return await self.execute_unary( request=request, method=MethodInfo( name="ListScripts", service_name="soulfire.v1.ScriptService", input=ListScriptsRequest, output=ListScriptsResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def activate_script( self, request: ActivateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> AsyncIterator[ScriptEvent]: """ Activates a script by registering its trigger event listeners. The script will begin responding to trigger events (tick, chat, etc.). Returns a stream of execution events as triggers fire and nodes execute. The stream remains open until the script is deactivated. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is already active Errors: INVALID_ARGUMENT if script graph is invalid (e.g., no trigger nodes) """ return self.execute_server_stream( request=request, method=MethodInfo( name="ActivateScript", service_name="soulfire.v1.ScriptService", input=ActivateScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def deactivate_script( self, request: DeactivateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> DeactivateScriptResponse: """ Deactivates an active script. Unregisters all event listeners and cancels any pending async operations. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is not active """ return await self.execute_unary( request=request, method=MethodInfo( name="DeactivateScript", service_name="soulfire.v1.ScriptService", input=DeactivateScriptRequest, output=DeactivateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def get_script_status( self, request: GetScriptStatusRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetScriptStatusResponse: """ Gets the current status of a script. Returns whether the script is active, which node is executing, and activation count. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ return await self.execute_unary( request=request, method=MethodInfo( name="GetScriptStatus", service_name="soulfire.v1.ScriptService", input=GetScriptStatusRequest, output=GetScriptStatusResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def subscribe_script_logs( self, request: SubscribeScriptLogsRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> AsyncIterator[ScriptLogEntry]: """ Subscribes to log entries generated during script execution. Returns a stream of log entries at or above the specified minimum level. The stream remains open until cancelled by the client. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script log subscription permission """ return self.execute_server_stream( request=request, method=MethodInfo( name="SubscribeScriptLogs", service_name="soulfire.v1.ScriptService", input=SubscribeScriptLogsRequest, output=ScriptLogEntry, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def get_node_types( self, request: GetNodeTypesRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetNodeTypesResponse: """ Gets all available node types with their metadata. This enables clients to render the node editor without hardcoded knowledge of specific node types. The response includes port definitions, categories, display names, and all other information needed to render and validate nodes. This endpoint is cacheable - node types only change between server versions. """ return await self.execute_unary( request=request, method=MethodInfo( name="GetNodeTypes", service_name="soulfire.v1.ScriptService", input=GetNodeTypesRequest, output=GetNodeTypesResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def get_registry_data( self, request: GetRegistryDataRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetRegistryDataResponse: """ Gets Minecraft registry data for autocomplete and validation. Returns blocks, entities, items, and biomes that can be used in scripts. This endpoint is cacheable - registry data only changes between server versions. """ return await self.execute_unary( request=request, method=MethodInfo( name="GetRegistryData", service_name="soulfire.v1.ScriptService", input=GetRegistryDataRequest, output=GetRegistryDataResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] async def validate_script( self, request: ValidateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> ValidateScriptResponse: """ Validates a script graph without saving it. Returns all diagnostics (errors and warnings) for the given nodes and edges. Useful for live validation in the editor without requiring a save. """ return await self.execute_unary( request=request, method=MethodInfo( name="ValidateScript", service_name="soulfire.v1.ScriptService", input=ValidateScriptRequest, output=ValidateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def dry_run_script( self, request: DryRunScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> AsyncIterator[ScriptEvent]: """ Dry-runs a script from a specified trigger with mock inputs. Executes the graph without requiring an active instance. Returns execution events as a stream for the editor to display. """ return self.execute_server_stream( request=request, method=MethodInfo( name="DryRunScript", service_name="soulfire.v1.ScriptService", input=DryRunScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), headers=headers, timeout_ms=timeout_ms, )
[docs] class ScriptServiceSync(Protocol): """ ScriptService provides management and execution capabilities for visual node-based automation scripts within SoulFire. The visual scripting system allows users to create automation workflows by connecting nodes in a graph. Each node represents an action, condition, or event trigger. Nodes are connected by edges that define execution flow and data transfer. SCRIPT LIFECYCLE: 1. Create a script using CreateScript with initial nodes/edges or empty graph 2. Edit the script using UpdateScript to modify the node graph 3. Activate the script using ActivateScript to register event listeners 4. Monitor execution via SubscribeScriptEvents or GetScriptStatus 5. Deactivate using DeactivateScript when done 6. Delete unused scripts with DeleteScript Scripts are reactive state machines - they don't "run" but rather listen for trigger events and execute node chains in response. Activation registers the listeners, deactivation removes them and cancels any pending async operations. PERMISSIONS: Script operations require appropriate instance permissions. The specific permissions are TBD but will likely include: - READ_SCRIPT: View script definitions and status - UPDATE_SCRIPT: Create, modify, and delete scripts - EXECUTE_SCRIPT: Activate and deactivate scripts LOGGING: Script execution logs can be streamed via SubscribeScriptLogs or filtered using InstanceScriptLogScope in the LogsService (see logs.proto). """
[docs] def create_script(self, request: CreateScriptRequest, ctx: RequestContext[CreateScriptRequest, CreateScriptResponse], /) -> CreateScriptResponse: """ Creates a new script in the specified instance. The script can be created with initial nodes and edges, or as a blank script to be edited later. Returns: The complete script data including the generated ID Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script creation permission Errors: INVALID_ARGUMENT if required fields are missing or invalid """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def get_script(self, request: GetScriptRequest, ctx: RequestContext[GetScriptRequest, GetScriptResponse], /) -> GetScriptResponse: """ Retrieves a specific script by its ID. Returns the complete script data including all nodes and edges. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def update_script(self, request: UpdateScriptRequest, ctx: RequestContext[UpdateScriptRequest, UpdateScriptResponse], /) -> UpdateScriptResponse: """ Updates an existing script's metadata and/or node graph. Only specified fields are updated; others remain unchanged. Use update_nodes/update_edges flags to explicitly set empty lists. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script update permission Errors: INVALID_ARGUMENT if update data is invalid """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def delete_script(self, request: DeleteScriptRequest, ctx: RequestContext[DeleteScriptRequest, DeleteScriptResponse], /) -> DeleteScriptResponse: """ Permanently deletes a script. If the script is currently active, it will be deactivated first. This operation cannot be undone. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script delete permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def list_scripts(self, request: ListScriptsRequest, ctx: RequestContext[ListScriptsRequest, ListScriptsResponse], /) -> ListScriptsResponse: """ Lists all scripts in the specified instance. Returns summary information (ScriptInfo) without full node/edge data to reduce response size. Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def activate_script(self, request: ActivateScriptRequest, ctx: RequestContext[ActivateScriptRequest, ScriptEvent], /) -> Iterator[ScriptEvent]: """ Activates a script by registering its trigger event listeners. The script will begin responding to trigger events (tick, chat, etc.). Returns a stream of execution events as triggers fire and nodes execute. The stream remains open until the script is deactivated. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is already active Errors: INVALID_ARGUMENT if script graph is invalid (e.g., no trigger nodes) """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def deactivate_script(self, request: DeactivateScriptRequest, ctx: RequestContext[DeactivateScriptRequest, DeactivateScriptResponse], /) -> DeactivateScriptResponse: """ Deactivates an active script. Unregisters all event listeners and cancels any pending async operations. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is not active """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def get_script_status(self, request: GetScriptStatusRequest, ctx: RequestContext[GetScriptStatusRequest, GetScriptStatusResponse], /) -> GetScriptStatusResponse: """ Gets the current status of a script. Returns whether the script is active, which node is executing, and activation count. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def subscribe_script_logs(self, request: SubscribeScriptLogsRequest, ctx: RequestContext[SubscribeScriptLogsRequest, ScriptLogEntry], /) -> Iterator[ScriptLogEntry]: """ Subscribes to log entries generated during script execution. Returns a stream of log entries at or above the specified minimum level. The stream remains open until cancelled by the client. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script log subscription permission """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def get_node_types(self, request: GetNodeTypesRequest, ctx: RequestContext[GetNodeTypesRequest, GetNodeTypesResponse], /) -> GetNodeTypesResponse: """ Gets all available node types with their metadata. This enables clients to render the node editor without hardcoded knowledge of specific node types. The response includes port definitions, categories, display names, and all other information needed to render and validate nodes. This endpoint is cacheable - node types only change between server versions. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def get_registry_data(self, request: GetRegistryDataRequest, ctx: RequestContext[GetRegistryDataRequest, GetRegistryDataResponse], /) -> GetRegistryDataResponse: """ Gets Minecraft registry data for autocomplete and validation. Returns blocks, entities, items, and biomes that can be used in scripts. This endpoint is cacheable - registry data only changes between server versions. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def validate_script(self, request: ValidateScriptRequest, ctx: RequestContext[ValidateScriptRequest, ValidateScriptResponse], /) -> ValidateScriptResponse: """ Validates a script graph without saving it. Returns all diagnostics (errors and warnings) for the given nodes and edges. Useful for live validation in the editor without requiring a save. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] def dry_run_script(self, request: DryRunScriptRequest, ctx: RequestContext[DryRunScriptRequest, ScriptEvent], /) -> Iterator[ScriptEvent]: """ Dry-runs a script from a specified trigger with mock inputs. Executes the graph without requiring an active instance. Returns execution events as a stream for the editor to display. """ raise ConnectError(Code.UNIMPLEMENTED, 'Not implemented')
[docs] class ScriptServiceWSGIApplication(ConnectWSGIApplication): def __init__( self, service: ScriptServiceSync, interceptors: Iterable[InterceptorSync] = (), read_max_bytes: int | None = DEFAULT_READ_MAX_BYTES, compressions: Iterable[Compression] | None = None, codecs: Iterable[Codec] | None = _DEFAULT_CODECS, ) -> None: super().__init__( endpoints={ "/soulfire.v1.ScriptService/CreateScript": EndpointSync.unary( method=MethodInfo( name="CreateScript", service_name="soulfire.v1.ScriptService", input=CreateScriptRequest, output=CreateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.create_script, ), "/soulfire.v1.ScriptService/GetScript": EndpointSync.unary( method=MethodInfo( name="GetScript", service_name="soulfire.v1.ScriptService", input=GetScriptRequest, output=GetScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.get_script, ), "/soulfire.v1.ScriptService/UpdateScript": EndpointSync.unary( method=MethodInfo( name="UpdateScript", service_name="soulfire.v1.ScriptService", input=UpdateScriptRequest, output=UpdateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.update_script, ), "/soulfire.v1.ScriptService/DeleteScript": EndpointSync.unary( method=MethodInfo( name="DeleteScript", service_name="soulfire.v1.ScriptService", input=DeleteScriptRequest, output=DeleteScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.delete_script, ), "/soulfire.v1.ScriptService/ListScripts": EndpointSync.unary( method=MethodInfo( name="ListScripts", service_name="soulfire.v1.ScriptService", input=ListScriptsRequest, output=ListScriptsResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.list_scripts, ), "/soulfire.v1.ScriptService/ActivateScript": EndpointSync.server_stream( method=MethodInfo( name="ActivateScript", service_name="soulfire.v1.ScriptService", input=ActivateScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), function=service.activate_script, ), "/soulfire.v1.ScriptService/DeactivateScript": EndpointSync.unary( method=MethodInfo( name="DeactivateScript", service_name="soulfire.v1.ScriptService", input=DeactivateScriptRequest, output=DeactivateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.deactivate_script, ), "/soulfire.v1.ScriptService/GetScriptStatus": EndpointSync.unary( method=MethodInfo( name="GetScriptStatus", service_name="soulfire.v1.ScriptService", input=GetScriptStatusRequest, output=GetScriptStatusResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.get_script_status, ), "/soulfire.v1.ScriptService/SubscribeScriptLogs": EndpointSync.server_stream( method=MethodInfo( name="SubscribeScriptLogs", service_name="soulfire.v1.ScriptService", input=SubscribeScriptLogsRequest, output=ScriptLogEntry, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), function=service.subscribe_script_logs, ), "/soulfire.v1.ScriptService/GetNodeTypes": EndpointSync.unary( method=MethodInfo( name="GetNodeTypes", service_name="soulfire.v1.ScriptService", input=GetNodeTypesRequest, output=GetNodeTypesResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.get_node_types, ), "/soulfire.v1.ScriptService/GetRegistryData": EndpointSync.unary( method=MethodInfo( name="GetRegistryData", service_name="soulfire.v1.ScriptService", input=GetRegistryDataRequest, output=GetRegistryDataResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.get_registry_data, ), "/soulfire.v1.ScriptService/ValidateScript": EndpointSync.unary( method=MethodInfo( name="ValidateScript", service_name="soulfire.v1.ScriptService", input=ValidateScriptRequest, output=ValidateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), function=service.validate_script, ), "/soulfire.v1.ScriptService/DryRunScript": EndpointSync.server_stream( method=MethodInfo( name="DryRunScript", service_name="soulfire.v1.ScriptService", input=DryRunScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), function=service.dry_run_script, ), }, interceptors=interceptors, read_max_bytes=read_max_bytes, compressions=compressions, codecs=codecs, ) @property def path(self) -> str: """Returns the URL path to mount the application to when serving multiple applications.""" return "/soulfire.v1.ScriptService"
[docs] class ScriptServiceClientSync(ConnectClientSync): """ ScriptService provides management and execution capabilities for visual node-based automation scripts within SoulFire. The visual scripting system allows users to create automation workflows by connecting nodes in a graph. Each node represents an action, condition, or event trigger. Nodes are connected by edges that define execution flow and data transfer. SCRIPT LIFECYCLE: 1. Create a script using CreateScript with initial nodes/edges or empty graph 2. Edit the script using UpdateScript to modify the node graph 3. Activate the script using ActivateScript to register event listeners 4. Monitor execution via SubscribeScriptEvents or GetScriptStatus 5. Deactivate using DeactivateScript when done 6. Delete unused scripts with DeleteScript Scripts are reactive state machines - they don't "run" but rather listen for trigger events and execute node chains in response. Activation registers the listeners, deactivation removes them and cancels any pending async operations. PERMISSIONS: Script operations require appropriate instance permissions. The specific permissions are TBD but will likely include: - READ_SCRIPT: View script definitions and status - UPDATE_SCRIPT: Create, modify, and delete scripts - EXECUTE_SCRIPT: Activate and deactivate scripts LOGGING: Script execution logs can be streamed via SubscribeScriptLogs or filtered using InstanceScriptLogScope in the LogsService (see logs.proto). """ def __init__( self, address: str, *, codec: Codec | None = _PROTO_BINARY_CODEC, protocol: ProtocolType = ProtocolType.CONNECT, accept_compression: Iterable[Compression] | None = None, send_compression: Compression | None = _GZIP_COMPRESSION, timeout_ms: int | None = None, read_max_bytes: int | None = None, interceptors: Iterable[InterceptorSync] = (), http_client: SyncClient | None = None, ) -> None: super().__init__( address=address, codec=codec, protocol=protocol, accept_compression=accept_compression, send_compression=send_compression, timeout_ms=timeout_ms, read_max_bytes=read_max_bytes, interceptors=interceptors, http_client=http_client, )
[docs] def create_script( self, request: CreateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> CreateScriptResponse: """ Creates a new script in the specified instance. The script can be created with initial nodes and edges, or as a blank script to be edited later. Returns: The complete script data including the generated ID Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script creation permission Errors: INVALID_ARGUMENT if required fields are missing or invalid """ return self.execute_unary( request=request, method=MethodInfo( name="CreateScript", service_name="soulfire.v1.ScriptService", input=CreateScriptRequest, output=CreateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def get_script( self, request: GetScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetScriptResponse: """ Retrieves a specific script by its ID. Returns the complete script data including all nodes and edges. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ return self.execute_unary( request=request, method=MethodInfo( name="GetScript", service_name="soulfire.v1.ScriptService", input=GetScriptRequest, output=GetScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def update_script( self, request: UpdateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> UpdateScriptResponse: """ Updates an existing script's metadata and/or node graph. Only specified fields are updated; others remain unchanged. Use update_nodes/update_edges flags to explicitly set empty lists. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script update permission Errors: INVALID_ARGUMENT if update data is invalid """ return self.execute_unary( request=request, method=MethodInfo( name="UpdateScript", service_name="soulfire.v1.ScriptService", input=UpdateScriptRequest, output=UpdateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def delete_script( self, request: DeleteScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> DeleteScriptResponse: """ Permanently deletes a script. If the script is currently active, it will be deactivated first. This operation cannot be undone. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script delete permission """ return self.execute_unary( request=request, method=MethodInfo( name="DeleteScript", service_name="soulfire.v1.ScriptService", input=DeleteScriptRequest, output=DeleteScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def list_scripts( self, request: ListScriptsRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> ListScriptsResponse: """ Lists all scripts in the specified instance. Returns summary information (ScriptInfo) without full node/edge data to reduce response size. Errors: NOT_FOUND if instance does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ return self.execute_unary( request=request, method=MethodInfo( name="ListScripts", service_name="soulfire.v1.ScriptService", input=ListScriptsRequest, output=ListScriptsResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def activate_script( self, request: ActivateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> Iterator[ScriptEvent]: """ Activates a script by registering its trigger event listeners. The script will begin responding to trigger events (tick, chat, etc.). Returns a stream of execution events as triggers fire and nodes execute. The stream remains open until the script is deactivated. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is already active Errors: INVALID_ARGUMENT if script graph is invalid (e.g., no trigger nodes) """ return self.execute_server_stream( request=request, method=MethodInfo( name="ActivateScript", service_name="soulfire.v1.ScriptService", input=ActivateScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def deactivate_script( self, request: DeactivateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> DeactivateScriptResponse: """ Deactivates an active script. Unregisters all event listeners and cancels any pending async operations. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script execution permission Errors: FAILED_PRECONDITION if script is not active """ return self.execute_unary( request=request, method=MethodInfo( name="DeactivateScript", service_name="soulfire.v1.ScriptService", input=DeactivateScriptRequest, output=DeactivateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def get_script_status( self, request: GetScriptStatusRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetScriptStatusResponse: """ Gets the current status of a script. Returns whether the script is active, which node is executing, and activation count. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script read permission """ return self.execute_unary( request=request, method=MethodInfo( name="GetScriptStatus", service_name="soulfire.v1.ScriptService", input=GetScriptStatusRequest, output=GetScriptStatusResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def subscribe_script_logs( self, request: SubscribeScriptLogsRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> Iterator[ScriptLogEntry]: """ Subscribes to log entries generated during script execution. Returns a stream of log entries at or above the specified minimum level. The stream remains open until cancelled by the client. Errors: NOT_FOUND if instance or script does not exist Errors: PERMISSION_DENIED if user lacks script log subscription permission """ return self.execute_server_stream( request=request, method=MethodInfo( name="SubscribeScriptLogs", service_name="soulfire.v1.ScriptService", input=SubscribeScriptLogsRequest, output=ScriptLogEntry, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def get_node_types( self, request: GetNodeTypesRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetNodeTypesResponse: """ Gets all available node types with their metadata. This enables clients to render the node editor without hardcoded knowledge of specific node types. The response includes port definitions, categories, display names, and all other information needed to render and validate nodes. This endpoint is cacheable - node types only change between server versions. """ return self.execute_unary( request=request, method=MethodInfo( name="GetNodeTypes", service_name="soulfire.v1.ScriptService", input=GetNodeTypesRequest, output=GetNodeTypesResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def get_registry_data( self, request: GetRegistryDataRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> GetRegistryDataResponse: """ Gets Minecraft registry data for autocomplete and validation. Returns blocks, entities, items, and biomes that can be used in scripts. This endpoint is cacheable - registry data only changes between server versions. """ return self.execute_unary( request=request, method=MethodInfo( name="GetRegistryData", service_name="soulfire.v1.ScriptService", input=GetRegistryDataRequest, output=GetRegistryDataResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def validate_script( self, request: ValidateScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> ValidateScriptResponse: """ Validates a script graph without saving it. Returns all diagnostics (errors and warnings) for the given nodes and edges. Useful for live validation in the editor without requiring a save. """ return self.execute_unary( request=request, method=MethodInfo( name="ValidateScript", service_name="soulfire.v1.ScriptService", input=ValidateScriptRequest, output=ValidateScriptResponse, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.UNARY, ), headers=headers, timeout_ms=timeout_ms, )
[docs] def dry_run_script( self, request: DryRunScriptRequest, *, headers: Headers | Mapping[str, str] | None = None, timeout_ms: int | None = None, ) -> Iterator[ScriptEvent]: """ Dry-runs a script from a specified trigger with mock inputs. Executes the graph without requiring an active instance. Returns execution events as a stream for the editor to display. """ return self.execute_server_stream( request=request, method=MethodInfo( name="DryRunScript", service_name="soulfire.v1.ScriptService", input=DryRunScriptRequest, output=ScriptEvent, idempotency_level=IdempotencyLevel.UNKNOWN, stream_type=StreamType.SERVER_STREAM, ), headers=headers, timeout_ms=timeout_ms, )