temporalio 1.5.0 → 1.6.0

data/sig/temporalio/workflow/definition.rbs

@@ -0,0 +1,181 @@
+module Temporalio
+  module Workflow
+    class Definition
+      def self.workflow_name: (String | Symbol workflow_name) -> void
+      def self.workflow_dynamic: (?bool value) -> void
+      def self.workflow_raw_args: (?bool value) -> void
+      def self.workflow_arg_hint: (*Object hints) -> void
+      def self.workflow_result_hint: (Object hint) -> void
+      def self.workflow_failure_exception_type: (*singleton(Exception) types) -> void
+      def self.workflow_query_attr_reader: (*Symbol attr_names, ?description: String?) -> void
+
+      def self.workflow_versioning_behavior: (VersioningBehavior::enum value) -> void
+
+      def self.workflow_init: (?bool value) -> void
+
+      def self.workflow_signal: (
+        ?name: String | Symbol | nil,
+        ?description: String?,
+        ?dynamic: bool,
+        ?raw_args: bool,
+        ?unfinished_policy: HandlerUnfinishedPolicy::enum,
+        ?arg_hints: Object | Array[Object] | nil
+      ) -> void
+
+      def self.workflow_query: (
+        ?name: String | Symbol | nil,
+        ?description: String?,
+        ?dynamic: bool,
+        ?raw_args: bool,
+        ?arg_hints: Object | Array[Object] | nil,
+        ?result_hint: Object?
+      ) -> void
+
+      def self.workflow_update: (
+        ?name: String | Symbol | nil,
+        ?description: String?,
+        ?dynamic: bool,
+        ?raw_args: bool,
+        ?unfinished_policy: HandlerUnfinishedPolicy::enum,
+        ?arg_hints: Object | Array[Object] | nil,
+        ?result_hint: Object?
+      ) -> void
+
+      def self.workflow_update_validator: (Symbol update_method) -> void
+
+      def self.workflow_dynamic_options: () -> void
+
+      def self.pending_handler_details: -> Hash[Symbol, untyped]?
+      def self.pending_handler_details=: (Hash[Symbol, untyped]? value) -> void
+
+      def self._workflow_definition: -> Info
+
+      def self._workflow_type_and_hints_from_workflow_parameter: (
+        singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String workflow
+      ) -> [String, Array[Object]?, Object?]
+
+      def self._build_workflow_definition: -> Info
+
+      def execute: (*Object? args) -> Object?
+
+      class Info
+        attr_reader workflow_class: singleton(Workflow::Definition)
+        attr_reader override_name: String?
+        attr_reader dynamic: bool
+        attr_reader init: bool
+        attr_reader raw_args: bool
+        attr_reader failure_exception_types: Array[singleton(Exception)]
+        attr_reader signals: Hash[String?, Signal]
+        attr_reader queries: Hash[String?, Query]
+        attr_reader updates: Hash[String?, Update]
+        attr_reader versioning_behavior: Integer?
+        attr_reader dynamic_options_method: Symbol?
+        attr_reader arg_hints: Array[Object]?
+        attr_reader result_hint: Object?
+
+        def self.from_class: (singleton(Definition) workflow_class) -> Info
+
+        def initialize: (
+          workflow_class: singleton(Workflow::Definition),
+          ?override_name: String?,
+          ?dynamic: bool,
+          ?init: bool,
+          ?raw_args: bool,
+          ?failure_exception_types: Array[singleton(Exception)],
+          ?signals: Hash[String, Signal],
+          ?queries: Hash[String, Query],
+          ?updates: Hash[String, Update],
+          ?versioning_behavior: Integer?,
+          ?dynamic_options_method: Symbol?,
+          ?arg_hints: Array[Object]?,
+          ?result_hint: Object?
+        ) -> void
+
+        def name: -> String?
+      end
+
+      class Signal
+        attr_reader name: String?
+        attr_reader to_invoke: Symbol | Proc
+        attr_reader description: String?
+        attr_reader raw_args: bool
+        attr_reader unfinished_policy: HandlerUnfinishedPolicy::enum
+        attr_reader arg_hints: Array[Object]?
+
+        def self._name_and_hints_from_parameter: (
+          Workflow::Definition::Signal | String | Symbol signal
+        ) -> [String, Array[Object]?]
+
+        def initialize: (
+          name: String?,
+          to_invoke: Symbol | Proc,
+          ?description: String?,
+          ?raw_args: bool,
+          ?unfinished_policy: HandlerUnfinishedPolicy::enum,
+          ?arg_hints: Array[Object]?
+        ) -> void
+      end
+
+      class Query
+        attr_reader name: String?
+        attr_reader to_invoke: Symbol | Proc
+        attr_reader description: String?
+        attr_reader raw_args: bool
+        attr_reader arg_hints: Array[Object]?
+        attr_reader result_hint: Object?
+
+        def self._name_and_hints_from_parameter: (
+          Workflow::Definition::Query | String | Symbol query
+        ) -> [String, Array[Object]?, Object?]
+
+        def initialize: (
+          name: String?,
+          to_invoke: Symbol | Proc,
+          ?description: String?,
+          ?raw_args: bool,
+          ?arg_hints: Array[Object]?,
+          ?result_hint: Object?
+        ) -> void
+      end
+
+      class Update
+        attr_reader name: String?
+        attr_reader to_invoke: Symbol | Proc
+        attr_reader description: String?
+        attr_reader raw_args: bool
+        attr_reader unfinished_policy: HandlerUnfinishedPolicy::enum
+        attr_reader validator_to_invoke: Symbol | Proc | nil
+        attr_reader arg_hints: Array[Object]?
+        attr_reader result_hint: Object?
+
+        def self._name_and_hints_from_parameter: (
+          Workflow::Definition::Update | String | Symbol update
+        ) -> [String, Array[Object]?, Object?]
+
+        def initialize: (
+          name: String?,
+          to_invoke: Symbol | Proc,
+          ?description: String?,
+          ?raw_args: bool,
+          ?unfinished_policy: HandlerUnfinishedPolicy::enum,
+          ?validator_to_invoke: Symbol | Proc | nil,
+          ?arg_hints: Array[Object]?,
+          ?result_hint: Object?
+        ) -> void
+
+        def _with_validator_to_invoke: (Symbol | Proc | nil validator_to_invoke) -> Update
+      end
+
+    end
+
+    class DefinitionOptions
+      attr_reader failure_exception_types: Array[singleton(Exception)]?
+      attr_reader versioning_behavior: VersioningBehavior::enum?
+
+      def initialize: (
+        ?failure_exception_types: Array[singleton(Exception)]?,
+        ?versioning_behavior: VersioningBehavior::enum?
+      ) -> void
+    end
+  end
+end

data/sig/temporalio/workflow/external_workflow_handle.rbs

@@ -0,0 +1,17 @@
+module Temporalio
+  module Workflow
+    class ExternalWorkflowHandle
+      def id: -> String
+      def run_id: -> String?
+
+      def signal: (
+        Workflow::Definition::Signal | Symbol | String signal,
+        *Object? args,
+        ?cancellation: Cancellation,
+        ?arg_hints: Array[Object]?
+      ) -> void
+
+      def cancel: -> void
+    end
+  end
+end

data/sig/temporalio/workflow/future.rbs

@@ -0,0 +1,24 @@
+module Temporalio
+  module Workflow
+    class Future[unchecked out T]
+      def self.any_of: [T] (*Future[T] futures) -> Future[T]
+      def self.all_of: (*Future[untyped] futures) -> Future[nil]
+      def self.try_any_of: [T] (*Future[T] futures) -> Future[Future[T]]
+      def self.try_all_of: (*Future[untyped] futures) -> Future[nil]
+
+      attr_reader result: T?
+      attr_reader failure: Exception?
+
+      def initialize: ?{ -> T } -> void
+
+      def done?: -> bool
+      def result?: -> bool
+      def result=: (T result) -> void
+      def failure?: -> bool
+      def failure=: (Exception failure) -> void
+
+      def wait: -> T
+      def wait_no_raise: -> T?
+    end
+  end
+end

data/sig/temporalio/workflow/handler_unfinished_policy.rbs

@@ -0,0 +1,10 @@
+module Temporalio
+  module Workflow
+    module HandlerUnfinishedPolicy
+      type enum = Integer
+
+      WARN_AND_ABANDON: enum
+      ABANDON: enum
+    end
+  end
+end

data/sig/temporalio/workflow/info.rbs

@@ -0,0 +1,79 @@
+module Temporalio
+  module Workflow
+    class Info
+      attr_reader attempt: Integer
+      attr_reader continued_run_id: String?
+      attr_reader cron_schedule: String?
+      attr_reader execution_timeout: Float?
+      attr_reader first_execution_run_id: String
+      attr_reader headers: Hash[String, untyped]
+      attr_reader last_failure: Exception?
+      attr_reader last_result: Object?
+      attr_reader has_last_result?: bool
+      attr_reader namespace: String
+      attr_reader parent: ParentInfo?
+      attr_reader priority: Temporalio::Priority
+      attr_reader retry_policy: RetryPolicy?
+      attr_reader root: RootInfo?
+      attr_reader run_id: String
+      attr_reader run_timeout: Float?
+      attr_reader start_time: Time
+      attr_reader task_queue: String
+      attr_reader task_timeout: Float
+      attr_reader workflow_id: String
+      attr_reader workflow_type: String
+
+      def initialize: (
+        attempt: Integer,
+        continued_run_id: String?,
+        cron_schedule: String?,
+        execution_timeout: Float?,
+        first_execution_run_id: String,
+        headers: Hash[String, untyped],
+        last_failure: Exception?,
+        last_result: Object?,
+        has_last_result?: bool,
+        namespace: String,
+        parent: ParentInfo?,
+        priority: Temporalio::Priority?,
+        retry_policy: RetryPolicy?,
+        root: RootInfo?,
+        run_id: String,
+        run_timeout: Float?,
+        start_time: Time,
+        task_queue: String,
+        task_timeout: Float,
+        workflow_id: String,
+        workflow_type: String
+      ) -> void
+
+      def to_h: -> Hash[Symbol, untyped]
+
+      class ParentInfo
+        attr_reader namespace: String
+        attr_reader run_id: String
+        attr_reader workflow_id: String
+
+        def initialize: (
+          namespace: String,
+          run_id: String,
+          workflow_id: String
+        ) -> void
+
+        def to_h: -> Hash[Symbol, String]
+      end
+
+      class RootInfo
+        attr_reader run_id: String
+        attr_reader workflow_id: String
+
+        def initialize: (
+          run_id: String,
+          workflow_id: String
+        ) -> void
+
+        def to_h: -> Hash[Symbol, String]
+      end
+    end
+  end
+end

data/sig/temporalio/workflow/nexus_client.rbs

@@ -0,0 +1,34 @@
+module Temporalio
+  module Workflow
+    class NexusClient
+      def endpoint: -> String
+      def service: -> String
+
+      def start_operation: (
+        Symbol | String operation,
+        Object? arg,
+        ?schedule_to_close_timeout: duration?,
+        ?schedule_to_start_timeout: duration?,
+        ?start_to_close_timeout: duration?,
+        ?cancellation_type: NexusOperationCancellationType::enum,
+        ?summary: String?,
+        ?cancellation: Cancellation,
+        ?arg_hint: Object?,
+        ?result_hint: Object?
+      ) -> NexusOperationHandle
+
+      def execute_operation: (
+        Symbol | String operation,
+        Object? arg,
+        ?schedule_to_close_timeout: duration?,
+        ?schedule_to_start_timeout: duration?,
+        ?start_to_close_timeout: duration?,
+        ?cancellation_type: NexusOperationCancellationType::enum,
+        ?summary: String?,
+        ?cancellation: Cancellation,
+        ?arg_hint: Object?,
+        ?result_hint: Object?
+      ) -> Object?
+    end
+  end
+end

data/sig/temporalio/workflow/nexus_operation_cancellation_type.rbs

@@ -0,0 +1,12 @@
+module Temporalio
+  module Workflow
+    module NexusOperationCancellationType
+      type enum = Integer
+
+      WAIT_CANCELLATION_COMPLETED: enum
+      ABANDON: enum
+      TRY_CANCEL: enum
+      WAIT_CANCELLATION_REQUESTED: enum
+    end
+  end
+end

data/sig/temporalio/workflow/nexus_operation_handle.rbs

@@ -0,0 +1,10 @@
+module Temporalio
+  module Workflow
+    class NexusOperationHandle
+      def operation_token: -> String?
+      def result_hint: -> Object?
+
+      def result: (?result_hint: Object?) -> Object?
+    end
+  end
+end

data/sig/temporalio/workflow/parent_close_policy.rbs

@@ -0,0 +1,12 @@
+module Temporalio
+  module Workflow
+    module ParentClosePolicy
+      type enum = Integer
+
+      UNSPECIFIED: enum
+      TERMINATE: enum
+      ABANDON: enum
+      REQUEST_CANCEL: enum
+    end
+  end
+end

data/sig/temporalio/workflow/update_info.rbs

@@ -0,0 +1,15 @@
+module Temporalio
+  module Workflow
+    class UpdateInfo
+      attr_reader id: String
+      attr_reader name: String
+
+      def initialize: (
+        id: String,
+        name: String
+      ) -> void
+
+      def to_h: -> Hash[Symbol, String]
+    end
+  end
+end

data/sig/temporalio/workflow.rbs

@@ -0,0 +1,215 @@
+module Temporalio
+  module Workflow
+    def self.all_handlers_finished?: -> bool
+
+    def self.cancellation: -> Cancellation
+
+    def self.continue_as_new_suggested: -> bool
+
+    def self.create_nexus_client: (endpoint: Symbol | String, service: Symbol | String) -> NexusClient
+
+    def self.suggest_continue_as_new_reasons: -> Array[SuggestContinueAsNewReason::enum]
+
+    def self.target_worker_deployment_version_changed?: -> bool
+
+    def self.current_details: -> String
+    def self.current_details=: (String? details) -> void
+
+    def self.current_history_length: -> Integer
+
+    def self.current_deployment_version: -> WorkerDeploymentVersion?
+
+    def self.current_history_size: -> Integer
+
+    def self.current_update_info: -> UpdateInfo?
+
+    def self.deprecate_patch: (Symbol | String patch_id) -> void
+
+    def self.execute_activity: (
+      singleton(Activity::Definition) | Symbol | String activity,
+      *Object? args,
+      ?task_queue: String,
+      ?summary: String?,
+      ?schedule_to_close_timeout: duration?,
+      ?schedule_to_start_timeout: duration?,
+      ?start_to_close_timeout: duration?,
+      ?heartbeat_timeout: duration?,
+      ?retry_policy: RetryPolicy?,
+      ?cancellation: Cancellation,
+      ?cancellation_type: ActivityCancellationType::enum,
+      ?activity_id: String?,
+      ?disable_eager_execution: bool,
+      ?priority: Priority,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?
+    ) -> Object?
+
+    def self.execute_child_workflow: (
+      singleton(Definition) | Definition::Info | Symbol | String workflow,
+      *Object? args,
+      ?id: String,
+      ?task_queue: String,
+      ?static_summary: String?,
+      ?static_details: String?,
+      ?cancellation: Cancellation,
+      ?cancellation_type: ChildWorkflowCancellationType::enum,
+      ?parent_close_policy: ParentClosePolicy::enum,
+      ?execution_timeout: duration?,
+      ?run_timeout: duration?,
+      ?task_timeout: duration?,
+      ?id_reuse_policy: WorkflowIDReusePolicy::enum,
+      ?retry_policy: RetryPolicy?,
+      ?cron_schedule: String?,
+      ?memo: Hash[String | Symbol, Object?]?,
+      ?search_attributes: SearchAttributes?,
+      ?priority: Priority,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?
+    ) -> Object?
+
+    def self.execute_local_activity: (
+      singleton(Activity::Definition) | Symbol | String activity,
+      *Object? args,
+      ?summary: String?,
+      ?schedule_to_close_timeout: duration?,
+      ?schedule_to_start_timeout: duration?,
+      ?start_to_close_timeout: duration?,
+      ?retry_policy: RetryPolicy?,
+      ?local_retry_threshold: duration?,
+      ?cancellation: Cancellation,
+      ?cancellation_type: ActivityCancellationType::enum,
+      ?activity_id: String?,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?
+    ) -> Object?
+
+    def self.external_workflow_handle: (String workflow_id, ?run_id: String?) -> ExternalWorkflowHandle
+
+    def self.in_workflow?: -> bool
+
+    def self.info: -> Info
+
+    def self.instance: -> Definition?
+
+    def self.logger: -> ScopedLogger
+
+    def self.memo: -> Hash[String, Object?]
+
+    def self.metric_meter: -> Metric::Meter
+
+    def self.now: -> Time
+
+    def self.patched: (Symbol | String patch_id) -> bool
+
+    def self.payload_converter: -> Converters::PayloadConverter
+
+    def self.query_handlers: -> Hash[String?, Workflow::Definition::Query]
+
+    def self.random: -> Random
+
+    def self.search_attributes: -> SearchAttributes
+
+    def self.signal_handlers: -> Hash[String?, Workflow::Definition::Signal]
+
+    def self.sleep: (duration? duration, ?summary: String?, ?cancellation: Cancellation) -> void
+
+    def self.start_child_workflow: (
+      singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String workflow,
+      *Object? args,
+      ?id: String,
+      ?task_queue: String,
+      ?static_summary: String?,
+      ?static_details: String?,
+      ?cancellation: Cancellation,
+      ?cancellation_type: Workflow::ChildWorkflowCancellationType::enum,
+      ?parent_close_policy: Workflow::ParentClosePolicy::enum,
+      ?execution_timeout: duration?,
+      ?run_timeout: duration?,
+      ?task_timeout: duration?,
+      ?id_reuse_policy: WorkflowIDReusePolicy::enum,
+      ?retry_policy: RetryPolicy?,
+      ?cron_schedule: String?,
+      ?memo: Hash[String | Symbol, Object?]?,
+      ?search_attributes: SearchAttributes?,
+      ?priority: Priority,
+      ?arg_hints: Array[Object]?,
+      ?result_hint: Object?
+    ) -> ChildWorkflowHandle
+
+    def self.storage: -> Hash[Object, Object]
+
+    def self.timeout: [T] (
+      duration? duration,
+      ?singleton(Exception) exception_class,
+      ?String message,
+      ?summary: String?
+    ) { -> T } -> T
+
+    def self.update_handlers: -> Hash[String?, Workflow::Definition::Update]
+
+    def self.upsert_memo: (Hash[Symbol | String, Object?] hash) -> void
+
+    def self.upsert_search_attributes: (*SearchAttributes::Update updates) -> void
+
+    def self.wait_condition: [T] (?cancellation: Cancellation?) { -> T } -> T
+
+    def self._current: -> Internal::Worker::WorkflowInstance::Context
+    def self._current_or_nil: -> Internal::Worker::WorkflowInstance::Context?
+
+    module Unsafe
+      def self.replaying?: -> bool
+
+      def self.replaying_history_events?: -> bool
+
+      def self.illegal_call_tracing_disabled: [T] { -> T } -> T
+
+      def self.io_enabled: [T] { -> T } -> T
+
+      def self.durable_scheduler_disabled: [T] { -> T } -> T
+
+      def self._wrap_ruby_class_as_legal: (Class target_class) -> Class
+    end
+
+    class ContinueAsNewError < Error
+      attr_accessor args: Array[Object?]
+      attr_accessor workflow: singleton(Workflow::Definition) | String | Symbol | nil
+      attr_accessor task_queue: String?
+      attr_accessor run_timeout: duration?
+      attr_accessor task_timeout: duration?
+      attr_accessor backoff_start_interval: duration?
+      attr_accessor retry_policy: RetryPolicy?
+      attr_accessor memo: Hash[String | Symbol, Object?]?
+      attr_accessor search_attributes: SearchAttributes?
+      attr_accessor arg_hints: Array[Object]?
+      attr_accessor headers: Hash[String, Object?]
+      attr_accessor initial_versioning_behavior: ContinueAsNewVersioningBehavior::enum?
+
+      def initialize: (
+        *Object? args,
+        ?workflow: singleton(Workflow::Definition) | String | Symbol | nil,
+        ?task_queue: String?,
+        ?run_timeout: duration?,
+        ?task_timeout: duration?,
+        ?backoff_start_interval: duration?,
+        ?retry_policy: RetryPolicy?,
+        ?memo: Hash[String | Symbol, Object?]?,
+        ?search_attributes: SearchAttributes?,
+        ?arg_hints: Array[Object]?,
+        ?headers: Hash[String, Object?],
+        ?initial_versioning_behavior: ContinueAsNewVersioningBehavior::enum?
+      ) -> void
+    end
+
+    class InvalidWorkflowStateError < Error
+    end
+    class NondeterminismError < Error
+    end
+
+    class Mutex < ::Mutex
+    end
+    class Queue < ::Queue
+    end
+    class SizedQueue < ::SizedQueue
+    end
+  end
+end

data/sig/temporalio/workflow_history.rbs

@@ -0,0 +1,13 @@
+module Temporalio
+  class WorkflowHistory
+    def self.from_history_json: (String json) -> WorkflowHistory
+
+    attr_reader events: Array[Api::History::V1::HistoryEvent]
+    
+    def initialize: (Array[Api::History::V1::HistoryEvent] events) -> void
+
+    def workflow_id: -> String
+
+    def to_history_json: -> String
+  end
+end

data/sig/temporalio.rbs

@@ -0,0 +1,3 @@
+module Temporalio
+  def self._root_file_path: -> String
+end

data/temporalio.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/temporalio/sdk-ruby'
 
-  spec.files = Dir['lib/**/*.rb', 'LICENSE', 'README.md', 'Cargo.*',
+  spec.files = Dir['lib/**/*.rb', 'sig/**/*.rbs', 'rbi/**/*.rbi', 'LICENSE', 'README.md', 'Cargo.*',
                    'temporalio.gemspec', 'Gemfile', 'Rakefile', '.yardopts']
 
   spec.bindir = 'exe'