api

type ActivityContextInfo struct {
	InstanceID InstanceID
	Name       string
	Version    string
	TaskID     int32
}

type CleanEntityStorageOptions struct {
	// ContinuationToken for resuming a previous cleanup operation.
	ContinuationToken string
	// PreserveEmptyEntities disables removal of entities with no state and no locks.
	PreserveEmptyEntities bool
	// PreserveOrphanedLocks disables release of locks held by non-running orchestrations.
	PreserveOrphanedLocks bool
	// SinglePage returns after one backend cleanup request.
	SinglePage bool
}

type CleanEntityStorageResult struct {
	// EmptyEntitiesRemoved is the number of empty entities removed.
	EmptyEntitiesRemoved int32
	// OrphanedLocksReleased is the number of orphaned locks released.
	OrphanedLocksReleased int32
	// ContinuationToken for resuming cleanup. Empty if complete.
	ContinuationToken string
}

type ContextFields map[string]string

type DataConverter interface {
	Serialize(value any) (string, error)
	Deserialize(payload string, target any) error
}

type DurableTaskErrorPropertiesProvider interface {
	DurableTaskErrorProperties() map[string]any
}

type DurableTaskErrorTypeProvider interface {
	DurableTaskErrorType() ErrorType
}

type DurableTaskFailureDetailsProvider interface {
	DurableTaskFailureDetails() *FailureDetails
}

type DurableTaskStackTraceProvider interface {
	DurableTaskStackTrace() string
}

type EntityContextInfo struct {
	EntityID  EntityID
	Operation string
	RequestID string
	IsSignal  bool
}

type EntityID struct {
	Name string
	Key  string
}

type EntityMetadata struct {
	InstanceID       EntityID
	LastModifiedTime time.Time
	BacklogQueueSize int32
	LockedBy         string
	StateIncluded    bool
	HasState         bool
	SerializedState  string
	Converter        DataConverter `json:"-"`
}

type EntityQuery struct {
	// InstanceIDStartsWith filters entities whose instance ID starts with this prefix.
	InstanceIDStartsWith string
	// LastModifiedFrom filters entities modified on or after this time.
	LastModifiedFrom time.Time
	// LastModifiedTo filters entities modified before this time.
	LastModifiedTo time.Time
	// ExcludeState omits entity state from the results. State is included by default.
	ExcludeState bool
	// IncludeTransient whether to include transient (stateless) entities.
	IncludeTransient bool
	// PageSize limits the number of entities returned per page.
	PageSize int32
	// ContinuationToken for fetching the next page of results.
	ContinuationToken string
}

type EntityQueryResults struct {
	Entities          []*EntityMetadata
	ContinuationToken string
}

type ErrorPropertiesProvider interface {
	ErrorProperties(error) map[string]any
}

type ErrorPropertiesProviderFunc func(error) map[string]any

type ErrorType string

type FailureDetails struct {
	ErrorType      ErrorType       `json:"type"`
	ErrorMessage   string          `json:"message"`
	StackTrace     string          `json:"stackTrace,omitempty"`
	InnerFailure   *FailureDetails `json:"innerFailure,omitempty"`
	IsNonRetriable bool            `json:"isNonRetriable,omitempty"`
	Properties     map[string]any  `json:"properties,omitempty"`
}

type FetchOrchestrationMetadataOptions func(*protos.GetInstanceRequest)

type GetEntityOptions struct {
	ExcludeState bool
}

type HistoryEntityEvent struct {
	RequestID         string          `json:"requestId,omitempty"`
	Operation         string          `json:"operation,omitempty"`
	TargetInstanceID  string          `json:"targetInstanceId,omitempty"`
	ParentInstanceID  string          `json:"parentInstanceId,omitempty"`
	ParentExecutionID string          `json:"parentExecutionId,omitempty"`
	ScheduledAt       time.Time       `json:"scheduledAt,omitempty"`
	CriticalSectionID string          `json:"criticalSectionId,omitempty"`
	LockSet           []string        `json:"lockSet,omitempty"`
	Position          int32           `json:"position,omitempty"`
	SerializedInput   string          `json:"serializedInput,omitempty"`
	SerializedOutput  string          `json:"serializedOutput,omitempty"`
	FailureDetails    *FailureDetails `json:"failureDetails,omitempty"`
}

type HistoryEvent struct {
	Type      HistoryEventType `json:"type"`
	EventID   int32            `json:"eventId"`
	Timestamp time.Time        `json:"timestamp"`
	// UnknownType identifies a wire event type that this SDK does not yet
	// understand. It is diagnostic and populated only for HistoryEventUnknown.
	UnknownType string `json:"unknownType,omitempty"`

	ExecutionStarted                  *HistoryExecutionStartedEvent                `json:"executionStarted,omitempty"`
	ExecutionCompleted                *HistoryExecutionCompletedEvent              `json:"executionCompleted,omitempty"`
	ExecutionTerminated               *HistoryExecutionTerminatedEvent             `json:"executionTerminated,omitempty"`
	TaskScheduled                     *HistoryTaskScheduledEvent                   `json:"taskScheduled,omitempty"`
	TaskCompleted                     *HistoryTaskResultEvent                      `json:"taskCompleted,omitempty"`
	TaskFailed                        *HistoryTaskFailureEvent                     `json:"taskFailed,omitempty"`
	SubOrchestrationInstanceCreated   *HistorySubOrchestrationInstanceCreatedEvent `json:"subOrchestrationInstanceCreated,omitempty"`
	SubOrchestrationInstanceCompleted *HistoryTaskResultEvent                      `json:"subOrchestrationInstanceCompleted,omitempty"`
	SubOrchestrationInstanceFailed    *HistoryTaskFailureEvent                     `json:"subOrchestrationInstanceFailed,omitempty"`
	TimerCreated                      *HistoryTimerEvent                           `json:"timerCreated,omitempty"`
	TimerFired                        *HistoryTimerFiredEvent                      `json:"timerFired,omitempty"`
	EventSent                         *HistoryExternalEvent                        `json:"eventSent,omitempty"`
	EventRaised                       *HistoryExternalEvent                        `json:"eventRaised,omitempty"`
	Generic                           *HistoryPayloadEvent                         `json:"generic,omitempty"`
	HistoryState                      *HistoryStateEvent                           `json:"historyState,omitempty"`
	ContinueAsNew                     *HistoryPayloadEvent                         `json:"continueAsNew,omitempty"`
	ExecutionSuspended                *HistoryPayloadEvent                         `json:"executionSuspended,omitempty"`
	ExecutionResumed                  *HistoryPayloadEvent                         `json:"executionResumed,omitempty"`
	Entity                            *HistoryEntityEvent                          `json:"entity,omitempty"`
	ExecutionRewound                  *HistoryExecutionRewoundEvent                `json:"executionRewound,omitempty"`

	Converter DataConverter `json:"-"`
}

type HistoryEventHandler func(*HistoryEvent) error

type HistoryEventType string

type HistoryExecutionCompletedEvent struct {
	RuntimeStatus    OrchestrationStatus `json:"runtimeStatus"`
	SerializedResult string              `json:"serializedResult,omitempty"`
	FailureDetails   *FailureDetails     `json:"failureDetails,omitempty"`
}

type HistoryExecutionRewoundEvent struct {
	Reason             string                     `json:"reason,omitempty"`
	Name               string                     `json:"name,omitempty"`
	Version            string                     `json:"version,omitempty"`
	InstanceID         InstanceID                 `json:"instanceId,omitempty"`
	ParentExecutionID  string                     `json:"parentExecutionId,omitempty"`
	SerializedInput    string                     `json:"serializedInput,omitempty"`
	Parent             *HistoryParentInstanceInfo `json:"parent,omitempty"`
	ParentTraceContext *HistoryTraceContext       `json:"parentTraceContext,omitempty"`
	Tags               map[string]string          `json:"tags,omitempty"`
	ContextFields      ContextFields              `json:"contextFields,omitempty"`
}

type HistoryExecutionStartedEvent struct {
	Name                string                     `json:"name"`
	Version             string                     `json:"version,omitempty"`
	InstanceID          InstanceID                 `json:"instanceId"`
	ExecutionID         string                     `json:"executionId,omitempty"`
	SerializedInput     string                     `json:"serializedInput,omitempty"`
	ScheduledStartAt    time.Time                  `json:"scheduledStartAt,omitempty"`
	Parent              *HistoryParentInstanceInfo `json:"parent,omitempty"`
	ParentTraceContext  *HistoryTraceContext       `json:"parentTraceContext,omitempty"`
	OrchestrationSpanID string                     `json:"orchestrationSpanId,omitempty"`
	Tags                map[string]string          `json:"tags,omitempty"`
	ContextFields       ContextFields              `json:"contextFields,omitempty"`
}

type HistoryExecutionTerminatedEvent struct {
	SerializedInput string `json:"serializedInput,omitempty"`
	Recursive       bool   `json:"recursive"`
}

type HistoryExternalEvent struct {
	InstanceID      InstanceID `json:"instanceId,omitempty"`
	Name            string     `json:"name"`
	SerializedInput string     `json:"serializedInput,omitempty"`
}

type HistoryParentInstanceInfo struct {
	Name            string     `json:"name,omitempty"`
	Version         string     `json:"version,omitempty"`
	InstanceID      InstanceID `json:"instanceId,omitempty"`
	ExecutionID     string     `json:"executionId,omitempty"`
	TaskScheduledID int32      `json:"taskScheduledId"`
}

type HistoryPayloadEvent struct {
	SerializedInput string `json:"serializedInput,omitempty"`
}

type HistoryQuery struct {
	// ExecutionID selects a specific execution. Empty selects the service's
	// current execution. GetOrchestrationHistory verifies a nonempty selection
	// against ExecutionStarted events and rejects missing or conflicting IDs.
	ExecutionID string
	// MaxEvents bounds the buffered GetOrchestrationHistory result. It is
	// validated but ignored by StreamOrchestrationHistory, which does not retain
	// events. Zero uses DefaultHistoryMaxEvents.
	MaxEvents int
	// MaxBytes bounds the approximate in-memory size of the buffered
	// GetOrchestrationHistory result. It is ignored by
	// StreamOrchestrationHistory. Zero uses DefaultHistoryMaxBytes.
	MaxBytes int
}

type HistoryStateEvent struct {
	State *OrchestrationMetadata `json:"state,omitempty"`
}

type HistorySubOrchestrationInstanceCreatedEvent struct {
	InstanceID         InstanceID           `json:"instanceId"`
	Name               string               `json:"name"`
	Version            string               `json:"version,omitempty"`
	SerializedInput    string               `json:"serializedInput,omitempty"`
	ParentTraceContext *HistoryTraceContext `json:"parentTraceContext,omitempty"`
	Tags               map[string]string    `json:"tags,omitempty"`
	ContextFields      ContextFields        `json:"contextFields,omitempty"`
}

type HistoryTaskFailureEvent struct {
	TaskScheduledID int32           `json:"taskScheduledId"`
	FailureDetails  *FailureDetails `json:"failureDetails,omitempty"`
}

type HistoryTaskResultEvent struct {
	TaskScheduledID  int32  `json:"taskScheduledId"`
	SerializedResult string `json:"serializedResult,omitempty"`
}

type HistoryTaskScheduledEvent struct {
	Name               string               `json:"name"`
	Version            string               `json:"version,omitempty"`
	SerializedInput    string               `json:"serializedInput,omitempty"`
	ParentTraceContext *HistoryTraceContext `json:"parentTraceContext,omitempty"`
	Tags               map[string]string    `json:"tags,omitempty"`
	ContextFields      ContextFields        `json:"contextFields,omitempty"`
}

type HistoryTimerEvent struct {
	FireAt time.Time `json:"fireAt"`
}

type HistoryTimerFiredEvent struct {
	FireAt  time.Time `json:"fireAt"`
	TimerID int32     `json:"timerId"`
}

type HistoryTraceContext struct {
	TraceParent string `json:"traceParent,omitempty"`
	TraceState  string `json:"traceState,omitempty"`
	SpanID      string `json:"spanId,omitempty"`
}

type InclusiveLargePayloadThreshold interface {
	UsesInclusiveLargePayloadThreshold() bool
}

type InstanceID string

type InstanceIDQuery struct {
	RuntimeStatus     []OrchestrationStatus
	CompletedTimeFrom time.Time
	CompletedTimeTo   time.Time
	PageSize          int
	ContinuationToken string
}

type InstanceIDQueryResult struct {
	InstanceIDs       []InstanceID
	ContinuationToken string
}

type JSONDataConverter struct{}

type LargePayloadDefaults interface {
	LargePayloadDefaults() (thresholdBytes, maxPayloadBytes int)
}

type LargePayloadOptions struct {
	Store      LargePayloadStore
	Resolver   LargePayloadResolver
	TokenStore LargePayloadTokenStore
	// ThresholdBytes uses storage-specific defaults when zero.
	ThresholdBytes int
	// MaxPayloadBytes uses storage-specific defaults when zero.
	MaxPayloadBytes int
}

type LargePayloadOptionsValidator interface {
	ValidateLargePayloadOptions(thresholdBytes, maxPayloadBytes int) error
}

type LargePayloadResolver interface {
	Resolve(context.Context, string) ([]byte, error)
}

type LargePayloadStore interface {
	Store(context.Context, []byte) (string, error)
}

type LargePayloadTokenStore interface {
	StoreToken(context.Context, []byte) (string, error)
	ResolveToken(context.Context, string) ([]byte, error)
	IsLargePayloadToken(string) bool
}

type LargePayloadTokenValidator interface {
	ValidateLargePayloadToken(string) error
}

type Logger interface {
	// Debug logs a message at level Debug.
	Debug(v ...any)
	// Debugf logs a message at level Debug.
	Debugf(format string, v ...any)
	// Info logs a message at level Info.
	Info(v ...any)
	// Infof logs a message at level Info.
	Infof(format string, v ...any)
	// Warn logs a message at level Warn.
	Warn(v ...any)
	// Warnf logs a message at level Warn.
	Warnf(format string, v ...any)
	// Error logs a message at level Error.
	Error(v ...any)
	// Errorf logs a message at level Error.
	Errorf(format string, v ...any)
}

type NewOrchestrationOptions func(*protos.CreateInstanceRequest, DataConverter) error

type NonRetriable interface {
	error
	NonRetriable() bool
}

type OrchestrationContextInfo struct {
	InstanceID       InstanceID
	Name             string
	Version          string
	ParentInstanceID InstanceID
}

type OrchestrationHistory struct {
	InstanceID InstanceID `json:"instanceId"`
	// ExecutionID is observed in ExecutionStarted events, never copied from the
	// query. It may be empty only for an unpinned history without such events.
	ExecutionID string          `json:"executionId,omitempty"`
	Events      []*HistoryEvent `json:"events"`
}

type OrchestrationIDReusePolicy struct {
	DedupeStatuses []OrchestrationStatus
}

type OrchestrationMetadata struct {
	InstanceID             InstanceID
	Name                   string
	Version                string
	ExecutionID            string
	ParentInstanceID       InstanceID
	RuntimeStatus          protos.OrchestrationStatus
	ScheduledStartAt       time.Time
	CreatedAt              time.Time
	LastUpdatedAt          time.Time
	CompletedAt            time.Time
	SerializedInput        string
	SerializedOutput       string
	SerializedCustomStatus string
	FailureDetails         *FailureDetails
	Tags                   map[string]string
	Converter              DataConverter `json:"-"`
}

type OrchestrationQuery struct {
	RuntimeStatus         []OrchestrationStatus
	CreatedTimeFrom       time.Time
	CreatedTimeTo         time.Time
	TaskHubNames          []string
	PageSize              int
	ContinuationToken     string
	InstanceIDPrefix      string
	FetchInputsAndOutputs bool
	// Tags are exact-match filters. The gRPC wire contract has no tag filter, so
	// the client scans a bounded number of service pages locally and can return a
	// partial page with a continuation token to resume from.
	Tags map[string]string
}

type OrchestrationQueryResult struct {
	Orchestrations    []*OrchestrationMetadata
	ContinuationToken string
}

type OrchestrationStatus = protos.OrchestrationStatus

type PurgeInstanceFilter struct {
	CreatedTimeFrom time.Time
	CreatedTimeTo   time.Time
	RuntimeStatus   []OrchestrationStatus
	Timeout         time.Duration
}

type PurgeInstancesRequest struct {
	InstanceIDs  []InstanceID
	Filter       *PurgeInstanceFilter
	Recursive    bool
	PollInterval time.Duration
}

type PurgeInstancesResult struct {
	DeletedInstanceCount int
	IsComplete           bool
}

type PurgeOptions func(*protos.PurgeInstancesRequest) error

type RaiseEventOptions func(*protos.RaiseEventRequest, DataConverter) error

type RestartOptions func(*protos.RestartInstanceRequest) error

type RewindOptions func(*protos.RewindInstanceRequest) error

type SignalEntityOptions func(*protos.SignalEntityRequest, DataConverter) error

type TerminateOptions func(*protos.TerminateRequest, DataConverter) error