temporalio 1.5.0 → 1.6.0

data/sig/temporalio/client.rbs

@@ -0,0 +1,271 @@
+module Temporalio
+  class Client
+    class Options
+      attr_reader connection: Connection
+      attr_reader namespace: String
+      attr_reader data_converter: Converters::DataConverter
+      attr_reader plugins: Array[Plugin]
+      attr_reader interceptors: Array[Interceptor]
+      attr_reader logger: Logger
+      attr_reader default_workflow_query_reject_condition: WorkflowQueryRejectCondition::enum?
+
+      def initialize: (
+        connection: Connection,
+        namespace: String,
+        data_converter: Converters::DataConverter,
+        plugins: Array[Plugin],
+        interceptors: Array[Interceptor],
+        logger: Logger,
+        default_workflow_query_reject_condition: WorkflowQueryRejectCondition::enum?
+      ) -> void
+
+      def to_h: -> Hash[Symbol, untyped]
+
+      def with: (**untyped) -> Options
+    end
+
+    class ListWorkflowPage
+      attr_reader executions: Array[WorkflowExecution]
+      attr_reader next_page_token: String?
+
+      def initialize: (
+        executions: Array[WorkflowExecution],
+        next_page_token: String?
+      ) -> void
+    end
+
+    def self.connect: (
+      String target_host,
+      String namespace,
+      ?api_key: String?,
+      ?tls: bool | Connection::TLSOptions | nil,
+      ?data_converter: Converters::DataConverter,
+      ?plugins: Array[Plugin],
+      ?interceptors: Array[Interceptor],
+      ?logger: Logger,
+      ?default_workflow_query_reject_condition: WorkflowQueryRejectCondition::enum?,
+      ?rpc_metadata: Hash[String, String],
+      ?rpc_retry: Connection::RPCRetryOptions,
+      ?identity: String,
+      ?keep_alive: Connection::KeepAliveOptions,
+      ?http_connect_proxy: Connection::HTTPConnectProxyOptions?,
+      ?runtime: Runtime,
+      ?lazy_connect: bool,
+      ?dns_load_balancing: Connection::DnsLoadBalancingOptions?,
+      ?grpc_compression: Connection::GrpcCompressionOptions::Gzip | Connection::GrpcCompressionOptions::None
+    ) -> Client
+
+    def self._validate_plugins!: (Array[Plugin] plugins) -> void
+
+    attr_reader options: Options
+
+    def initialize: (
+      connection: Connection,
+      namespace: String,
+      ?data_converter: Converters::DataConverter,
+      ?plugins: Array[Plugin],
+      ?interceptors: Array[Interceptor],
+      ?logger: Logger,
+      ?default_workflow_query_reject_condition: WorkflowQueryRejectCondition::enum?
+    ) -> void
+
+    def connection: -> Connection
+    def namespace: -> String
+    def data_converter: -> Converters::DataConverter
+    def _impl: -> Interceptor::Outbound
+    def workflow_service: -> Connection::WorkflowService
+    def operator_service: -> Connection::OperatorService
+
+    def start_workflow: (
+      singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String workflow,
+      *Object? args,
+      id: String,
+      task_queue: String,
+      ?static_summary: String?,
+      ?static_details: String?,
+      ?execution_timeout: duration?,
+      ?run_timeout: duration?,
+      ?task_timeout: duration?,
+      ?id_reuse_policy: WorkflowIDReusePolicy::enum,
+      ?id_conflict_policy: WorkflowIDConflictPolicy::enum,
+      ?retry_policy: RetryPolicy?,
+      ?cron_schedule: String?,
+      ?memo: Hash[String | Symbol, Object?]?,
+      ?search_attributes: SearchAttributes?,
+      ?start_delay: duration?,
+      ?request_eager_start: bool,
+      ?versioning_override: VersioningOverride?,
+      ?priority: Priority,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?,
+      ?rpc_options: RPCOptions?
+    ) -> WorkflowHandle
+
+    def execute_workflow: (
+      singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String workflow,
+      *Object? args,
+      id: String,
+      task_queue: String,
+      ?static_summary: String?,
+      ?static_details: String?,
+      ?execution_timeout: duration?,
+      ?run_timeout: duration?,
+      ?task_timeout: duration?,
+      ?id_reuse_policy: WorkflowIDReusePolicy::enum,
+      ?id_conflict_policy: WorkflowIDConflictPolicy::enum,
+      ?retry_policy: RetryPolicy?,
+      ?cron_schedule: String?,
+      ?memo: Hash[String | Symbol, Object?]?,
+      ?search_attributes: SearchAttributes?,
+      ?start_delay: duration?,
+      ?request_eager_start: bool,
+      ?versioning_override: VersioningOverride?,
+      ?priority: Priority,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?,
+      ?rpc_options: RPCOptions?
+    ) -> Object?
+
+    def workflow_handle: (
+      String workflow_id,
+      ?run_id: String?,
+      ?first_execution_run_id: String?,
+      ?result_hint: Object?
+    ) -> WorkflowHandle
+
+    def activity_handle: (
+      String activity_id,
+      ?activity_run_id: String?,
+      ?result_hint: Object?
+    ) -> ActivityHandle
+
+    def start_activity: (
+      singleton(Activity::Definition) | Activity::Definition | Activity::Definition::Info | Symbol | String activity,
+      *Object? args,
+      id: String,
+      task_queue: String,
+      ?schedule_to_close_timeout: duration?,
+      ?schedule_to_start_timeout: duration?,
+      ?start_to_close_timeout: duration?,
+      ?heartbeat_timeout: duration?,
+      ?id_reuse_policy: ActivityIDReusePolicy::enum,
+      ?id_conflict_policy: ActivityIDConflictPolicy::enum,
+      ?retry_policy: RetryPolicy?,
+      ?search_attributes: SearchAttributes?,
+      ?static_summary: String?,
+      ?static_details: String?,
+      ?priority: Priority,
+      ?start_delay: duration?,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?,
+      ?rpc_options: RPCOptions?
+    ) -> ActivityHandle
+
+    def execute_activity: (
+      singleton(Activity::Definition) | Activity::Definition | Activity::Definition::Info | Symbol | String activity,
+      *Object? args,
+      id: String,
+      task_queue: String,
+      ?schedule_to_close_timeout: duration?,
+      ?schedule_to_start_timeout: duration?,
+      ?start_to_close_timeout: duration?,
+      ?heartbeat_timeout: duration?,
+      ?id_reuse_policy: ActivityIDReusePolicy::enum,
+      ?id_conflict_policy: ActivityIDConflictPolicy::enum,
+      ?retry_policy: RetryPolicy?,
+      ?search_attributes: SearchAttributes?,
+      ?static_summary: String?,
+      ?static_details: String?,
+      ?priority: Priority,
+      ?start_delay: duration?,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?,
+      ?rpc_options: RPCOptions?
+    ) -> Object?
+
+    def list_activities: (String query, ?rpc_options: RPCOptions?) -> Enumerator[ActivityExecution, ActivityExecution]
+
+    def count_activities: (String query, ?rpc_options: RPCOptions?) -> ActivityExecutionCount
+
+    def start_update_with_start_workflow: (
+      Workflow::Definition::Update | Symbol | String update,
+      *Object? args,
+      start_workflow_operation: WithStartWorkflowOperation,
+      wait_for_stage: WorkflowUpdateWaitStage::enum,
+      ?id: String,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?,
+      ?rpc_options: RPCOptions?
+    ) -> WorkflowUpdateHandle
+
+    def execute_update_with_start_workflow: (
+      Workflow::Definition::Update | Symbol | String update,
+      *Object? args,
+      start_workflow_operation: WithStartWorkflowOperation,
+      ?id: String,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?,
+      ?rpc_options: RPCOptions?
+    ) -> Object?
+
+    def signal_with_start_workflow: (
+      Workflow::Definition::Signal | Symbol | String signal,
+      *Object? args,
+      start_workflow_operation: WithStartWorkflowOperation,
+      ?arg_hints: Array[Object]?,
+      ?rpc_options: RPCOptions?
+    ) -> WorkflowHandle
+
+    def list_workflows: (
+      ?String query,
+      ?rpc_options: RPCOptions?
+    ) -> Enumerator[WorkflowExecution, WorkflowExecution]
+
+    def list_workflow_page: (
+      ?String query,
+      ?next_page_token: String?,
+      ?page_size: Integer?,
+      ?rpc_options: RPCOptions?
+    ) -> ListWorkflowPage
+
+    def count_workflows: (
+      ?String query,
+      ?rpc_options: RPCOptions?
+    ) -> WorkflowExecutionCount
+
+    def create_schedule: (
+      String id,
+      Schedule schedule,
+      ?trigger_immediately: bool,
+      ?backfills: Array[Schedule::Backfill],
+      ?memo: Hash[String, Object?]?,
+      ?search_attributes: SearchAttributes?,
+      ?rpc_options: RPCOptions?
+    ) -> ScheduleHandle
+
+    def schedule_handle: (String id) -> ScheduleHandle
+
+    def list_schedules: (
+      ?String query,
+      ?rpc_options: RPCOptions?
+    ) -> Enumerator[Schedule::List::Description, Schedule::List::Description]
+
+    def async_activity_handle: (
+      String | ActivityIDReference task_token_or_id_reference
+    ) -> AsyncActivityHandle
+
+    class RPCOptions
+      attr_accessor metadata: Hash[String, String]?
+      attr_accessor timeout: Float?
+      attr_accessor cancellation: Cancellation?
+      attr_accessor override_retry: bool?
+
+      def initialize: (
+        ?metadata: Hash[String, String]?,
+        ?timeout: Float?,
+        ?cancellation: Cancellation?,
+        ?override_retry: bool?
+      ) -> void
+    end
+  end
+end

data/sig/temporalio/common_enums.rbs

@@ -0,0 +1,60 @@
+module Temporalio
+  module WorkflowIDReusePolicy
+    type enum = Integer
+
+    ALLOW_DUPLICATE: enum
+    ALLOW_DUPLICATE_FAILED_ONLY: enum
+    REJECT_DUPLICATE: enum
+    TERMINATE_IF_RUNNING: enum
+  end
+
+  module WorkflowIDConflictPolicy
+    type enum = Integer
+
+    UNSPECIFIED: enum
+    FAIL: enum
+    USE_EXISTING: enum
+    TERMINATE_EXISTING: enum
+  end
+
+  module ContinueAsNewVersioningBehavior
+    type enum = Integer
+
+    UNSPECIFIED: enum
+    AUTO_UPGRADE: enum
+    USE_RAMPING_VERSION: enum
+  end
+
+  module SuggestContinueAsNewReason
+    type enum = Integer
+
+    UNSPECIFIED: enum
+    HISTORY_SIZE_TOO_LARGE: enum
+    TOO_MANY_HISTORY_EVENTS: enum
+    TOO_MANY_UPDATES: enum
+  end
+
+  module VersioningBehavior
+    type enum = Integer
+
+    UNSPECIFIED: enum
+    PINNED: enum
+    AUTO_UPGRADE: enum
+  end
+
+  module ActivityIDReusePolicy
+    type enum = Integer
+
+    ALLOW_DUPLICATE: enum
+    ALLOW_DUPLICATE_FAILED_ONLY: enum
+    REJECT_DUPLICATE: enum
+  end
+
+  module ActivityIDConflictPolicy
+    type enum = Integer
+
+    UNSPECIFIED: enum
+    FAIL: enum
+    USE_EXISTING: enum
+  end
+end

data/sig/temporalio/contrib/open_telemetry.rbs

@@ -0,0 +1,74 @@
+module Temporalio
+  module Contrib
+    module OpenTelemetry
+      class TracingInterceptor
+        include Client::Interceptor
+        include Worker::Interceptor::Activity
+        include Worker::Interceptor::Workflow
+
+        attr_reader tracer: untyped
+
+        def initialize: (
+          untyped tracer,
+          ?header_key: String,
+          ?propagator: untyped,
+          ?always_create_workflow_spans: bool
+        ) -> void
+
+        def _apply_context_to_headers: (Hash[String, untyped] headers, ?context: untyped) -> void
+        def _attach_context: (Hash[String, untyped] headers) -> Object?
+        def _detach_context: (Object? token) -> void
+        def _context_from_headers: (Hash[String, untyped] headers) -> untyped
+        def _with_started_span: [T] (
+          name: String,
+          kind: Symbol,
+          ?attributes: Hash[untyped, untyped]?,
+          ?outbound_input: untyped
+        ) { () -> T } -> T
+        def _always_create_workflow_spans: -> bool
+
+        class ClientOutbound < Client::Interceptor::Outbound
+          def initialize: (TracingInterceptor root, Client::Interceptor::Outbound next_interceptor) -> void
+        end
+
+        class ActivityInbound < Worker::Interceptor::Activity::Inbound
+          def initialize: (TracingInterceptor root, Worker::Interceptor::Activity::Inbound next_interceptor) -> void
+        end
+
+        class WorkflowInbound < Worker::Interceptor::Workflow::Inbound
+          def initialize: (TracingInterceptor root, Worker::Interceptor::Workflow::Inbound next_interceptor) -> void
+
+          def _attach_context: (Hash[String, untyped] headers) -> Object?
+          def _detach_context: (Object? token) -> void
+          def _links_from_headers: (Hash[String, untyped] headers) -> Array[untyped]
+        end
+
+        class WorkflowOutbound < Worker::Interceptor::Workflow::Outbound
+          def initialize: (TracingInterceptor root, Worker::Interceptor::Workflow::Outbound next_interceptor) -> void
+
+          def _apply_span_to_headers: (Hash[String, untyped] headers, untyped span) -> void
+        end
+      end
+
+      module Workflow
+        def self.with_completed_span: [T] (
+          String name,
+          ?attributes: Hash[untyped, untyped],
+          ?links: Array[untyped]?,
+          ?kind: Symbol?,
+          ?exception: Exception?,
+          ?even_during_replay: bool
+        ) { -> T } -> T
+
+        def self.completed_span: (
+          String name,
+          ?attributes: Hash[untyped, untyped],
+          ?links: Array[untyped]?,
+          ?kind: Symbol?,
+          ?exception: Exception?,
+          ?even_during_replay: bool
+        ) -> untyped
+      end
+    end
+  end
+end

data/sig/temporalio/converters/data_converter.rbs

@@ -0,0 +1,32 @@
+module Temporalio
+  module Converters
+    class DataConverter
+      attr_reader payload_converter: PayloadConverter
+      attr_reader failure_converter: FailureConverter
+      attr_reader payload_codec: PayloadCodec?
+
+      def self.default: -> DataConverter
+
+      def initialize: (
+        ?payload_converter: PayloadConverter,
+        ?failure_converter: FailureConverter,
+        ?payload_codec: PayloadCodec?
+      ) -> void
+
+      def to_payload: (Object? value, ?hint: Object?) -> Temporalio::Api::Common::V1::Payload
+      def to_payloads: (
+        Array[Object?] values,
+        ?hints: Array[Object]?
+      ) -> Temporalio::Api::Common::V1::Payloads
+
+      def from_payload: (Temporalio::Api::Common::V1::Payload payload, ?hint: Object?) -> Object?
+      def from_payloads: (
+        Temporalio::Api::Common::V1::Payloads payloads,
+        ?hints: Array[Object]?
+      ) -> Array[Object?]
+
+      def to_failure: (Exception error) -> Api::Failure::V1::Failure
+      def from_failure: (Api::Failure::V1::Failure failure) -> Exception
+    end
+  end
+end

data/sig/temporalio/converters/failure_converter.rbs

@@ -0,0 +1,12 @@
+module Temporalio
+  module Converters
+    class FailureConverter
+      def self.default: -> FailureConverter
+
+      def initialize: (?encode_common_attributes: bool) -> void
+
+      def to_failure: (Exception error, DataConverter | PayloadConverter converter) -> Api::Failure::V1::Failure
+      def from_failure: (Api::Failure::V1::Failure failure, DataConverter | PayloadConverter converter) -> Exception
+    end
+  end
+end

data/sig/temporalio/converters/payload_codec.rbs

@@ -0,0 +1,8 @@
+module Temporalio
+  module Converters
+    class PayloadCodec
+      def encode: (Enumerable[Api::Common::V1::Payload] payloads) -> Array[Api::Common::V1::Payload]
+      def decode: (Enumerable[Api::Common::V1::Payload] payloads) -> Array[Api::Common::V1::Payload]
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/binary_null.rbs

@@ -0,0 +1,9 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class BinaryNull < Encoding
+        ENCODING: String
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/binary_plain.rbs

@@ -0,0 +1,9 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class BinaryPlain < Encoding
+        ENCODING: String
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/binary_protobuf.rbs

@@ -0,0 +1,9 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class BinaryProtobuf < Encoding
+        ENCODING: String
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/composite.rbs

@@ -0,0 +1,16 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class Composite < PayloadConverter
+        class ConverterNotFound < Error
+        end
+        class EncodingNotSet < Error
+        end
+
+        attr_reader converters: Hash[String, Encoding]
+
+        def initialize: (*Encoding converters) -> void
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/encoding.rbs

@@ -0,0 +1,13 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class Encoding
+        def encoding: -> String
+
+        def to_payload: (Object? value, ?hint: Object?) -> Temporalio::Api::Common::V1::Payload?
+
+        def from_payload: (Temporalio::Api::Common::V1::Payload payload, ?hint: Object?) -> Object?
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/json_plain.rbs

@@ -0,0 +1,14 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class JSONPlain < Encoding
+        ENCODING: String
+
+        def initialize: (
+          ?parse_options: Hash[Symbol, untyped],
+          ?generate_options: Hash[Symbol, untyped]
+        ) -> void
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter/json_protobuf.rbs

@@ -0,0 +1,9 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      class JSONProtobuf < Encoding
+        ENCODING: String
+      end
+    end
+  end
+end

data/sig/temporalio/converters/payload_converter.rbs

@@ -0,0 +1,24 @@
+module Temporalio
+  module Converters
+    class PayloadConverter
+      def self.default: -> Composite
+
+      def self.new_with_defaults: (
+        ?json_parse_options: Hash[Symbol, untyped],
+        ?json_generate_options: Hash[Symbol, untyped]
+      ) -> Composite
+
+      def to_payload: (Object? value, ?hint: Object?) -> Temporalio::Api::Common::V1::Payload
+      def to_payloads: (
+        Array[Object?] values,
+        ?hints: Array[Object]?
+      ) -> Temporalio::Api::Common::V1::Payloads
+
+      def from_payload: (Temporalio::Api::Common::V1::Payload? payload, ?hint: Object?) -> Object?
+      def from_payloads: (
+        Temporalio::Api::Common::V1::Payloads payloads,
+        ?hints: Array[Object]?
+      ) -> Array[Object?]
+    end
+  end
+end

data/sig/temporalio/converters/raw_value.rbs

@@ -0,0 +1,9 @@
+module Temporalio
+  module Converters
+    class RawValue
+      attr_reader payload: Api::Common::V1::Payload
+
+      def initialize: (Api::Common::V1::Payload payload) -> void
+    end
+  end
+end

data/sig/temporalio/converters.rbs

@@ -0,0 +1,4 @@
+module Temporalio
+  module Converters
+  end
+end

data/sig/temporalio/env_config.rbs

@@ -0,0 +1,86 @@
+module Temporalio
+  module EnvConfig
+    def self._source_to_path_and_data: (untyped source) -> [String?, String?]
+
+    class ClientConfigTLS
+      attr_reader disabled: bool?
+      attr_reader server_name: String?
+      attr_reader server_root_ca_cert: (Pathname | String)?
+      attr_reader client_cert: (Pathname | String)?
+      attr_reader client_private_key: (Pathname | String)?
+
+      def self.from_h: (Hash[untyped, untyped]? hash) -> ClientConfigTLS?
+      def self.hash_to_source: (Hash[untyped, untyped]? hash) -> (Pathname | String)?
+
+      def initialize: (
+        ?disabled: bool?,
+        ?server_name: String?,
+        ?server_root_ca_cert: (Pathname | String)?,
+        ?client_cert: (Pathname | String)?,
+        ?client_private_key: (Pathname | String)?
+      ) -> void
+
+      def to_h: -> Hash[Symbol, untyped]
+      def to_client_tls_options: -> (Client::Connection::TLSOptions | false)
+
+      private
+
+      def source_to_hash: (untyped source) -> Hash[Symbol, String]?
+      def read_source: (untyped source) -> String?
+    end
+
+    class ClientConfigProfile
+      attr_reader address: String?
+      attr_reader namespace: String?
+      attr_reader api_key: String?
+      attr_reader tls: ClientConfigTLS?
+      attr_reader grpc_meta: Hash[String, String]
+
+      def self.from_h: (Hash[untyped, untyped] hash) -> ClientConfigProfile
+
+      def self.load: (
+        ?profile: String?,
+        ?config_source: (Pathname | String)?,
+        ?disable_file: bool,
+        ?disable_env: bool,
+        ?config_file_strict: bool,
+        ?override_env_vars: Hash[String, String]?
+      ) -> ClientConfigProfile
+
+      def initialize: (
+        ?address: String?,
+        ?namespace: String?,
+        ?api_key: String?,
+        ?tls: ClientConfigTLS?,
+        ?grpc_meta: Hash[String, String]
+      ) -> void
+
+      def to_h: -> Hash[Symbol, untyped]
+      def to_client_connect_options: -> [Array[untyped], Hash[Symbol, untyped]]
+    end
+
+    class ClientConfig
+      attr_reader profiles: Hash[String, ClientConfigProfile]
+
+      def self.from_h: (Hash[untyped, untyped] hash) -> ClientConfig
+
+      def self.load: (
+        ?config_source: (Pathname | String)?,
+        ?config_file_strict: bool,
+        ?override_env_vars: Hash[String, String]?
+      ) -> ClientConfig
+
+      def self.load_client_connect_options: (
+        ?profile: String?,
+        ?config_source: (Pathname | String)?,
+        ?disable_file: bool,
+        ?disable_env: bool,
+        ?config_file_strict: bool,
+        ?override_env_vars: Hash[String, String]?
+      ) -> [Array[untyped], Hash[Symbol, untyped]]
+
+      def initialize: (?profiles: Hash[String, ClientConfigProfile]) -> void
+      def to_h: -> Hash[String, Hash[Symbol, untyped]]
+    end
+  end
+end