workflow

type CreateOpts[I any] struct {
	// (required) The friendly name of the workflow
	Name string

	// (optional) The version of the workflow
	Version string

	// (optional) The human-readable description of the workflow
	Description string

	// (optional) The event names that trigger the workflow
	OnEvents []string

	// (optional) The cron expressions for scheduled workflow runs
	OnCron []string

	// (optional) Concurrency settings to control parallel execution
	Concurrency *types.Concurrency

	// (optional) Task to execute when workflow fails
	OnFailureTask *task.OnFailureTaskDeclaration[I]

	// (optional) Strategy for sticky execution of workflow runs
	StickyStrategy *types.StickyStrategy

	// (optional) Default settings for all tasks within this workflow
	TaskDefaults *task.TaskDefaults
}

type DurableWrappedTaskFn func(ctx worker.DurableHatchetContext) (interface{}, error)

type NamedFunction struct {
	ActionID string
	Fn       WrappedTaskFn
}

type RunAsChildOpts struct {
	RunOpts
	Sticky *bool
	Key    *string
}

type RunOpts struct {
	AdditionalMetadata *map[string]interface{}
	// contains filtered or unexported fields
}

type TaskWithSpecificOutput[I any, T any] struct {
	Name string
	Fn   func(input I, ctx worker.HatchetContext) (*T, error)
}

type WorkflowBase interface {
	// Dump converts the workflow declaration into a protobuf request and function mappings.
	// Returns the workflow definition, regular task functions, durable task functions, and the on failure task function.
	Dump() (*contracts.CreateWorkflowVersionRequest, []NamedFunction, []NamedFunction, WrappedTaskFn)
}

type WorkflowDeclaration[I any, O any] interface {
	WorkflowBase

	// Task registers a task that will be executed as part of the workflow
	Task(opts task.CreateOpts[I]) *task.TaskDeclaration[I]

	// DurableTask registers a durable task that will be executed as part of the workflow.
	// Durable tasks can be paused and resumed across workflow runs, making them suitable
	// for long-running operations or tasks that require human intervention.
	DurableTask(opts task.CreateOpts[I]) *task.DurableTaskDeclaration[I]

	// Run executes the workflow with the provided input.
	Run(input I, opts ...RunOpts) (*O, error)

	// RunChild executes a child workflow with the provided input.
	RunAsChild(ctx worker.HatchetContext, input I, opts ...RunAsChildOpts) (*O, error)

	// RunNoWait executes the workflow with the provided input without waiting for it to complete.
	// Instead it returns a run ID that can be used to check the status of the workflow.
	RunNoWait(input I, opts ...RunOpts) (*v0Client.Workflow, error)

	// Cron schedules the workflow to run on a regular basis using a cron expression.
	Cron(name string, cronExpr string, input I, opts ...RunOpts) (*rest.CronWorkflows, error)

	// Schedule schedules the workflow to run at a specific time.
	Schedule(triggerAt time.Time, input I, opts ...RunOpts) (*rest.ScheduledWorkflows, error)

	// Get retrieves the current state of the workflow.
	Get() (*rest.Workflow, error)

	// Metrics retrieves metrics for this workflow.
	Metrics(opts ...rest.WorkflowGetMetricsParams) (*rest.WorkflowMetrics, error)

	// QueueMetrics retrieves queue metrics for this workflow.
	QueueMetrics(opts ...rest.TenantGetQueueMetricsParams) (*rest.TenantGetQueueMetricsResponse, error)
}

type WrappedTaskFn func(ctx worker.HatchetContext) (interface{}, error)