workflow

package module

Go to main page

Versions in this module

v0

v0.8.0

Jul 6, 2026

Changes in this version

+ var ErrConflict = errors.New("version conflict")

+ var ErrDefinitionMismatch = errors.New("workflow definition mismatch")

+ var ErrGuardRejected = &blockedError

+ var ErrInvalidDefinition = errors.New("invalid definition")

+ var ErrInvalidExpression = errors.New("invalid expression")

+ var ErrInvalidMarking = errors.New("invalid marking")

+ var ErrInvalidToken = errors.New("invalid token")

+ var ErrInvalidWorkflow = errors.New("invalid workflow")

+ var ErrNotEnabled = &blockedError

+ var ErrPlaceNotFound = errors.New("place not found")

+ var ErrTokenNotFound = errors.New("token not found")

+ var ErrTransitionNotFound = errors.New("transition not found")

+ var ErrWorkflowExists = errors.New("workflow already exists")

+ var ErrWorkflowNotFound = errors.New("workflow not found")

type BaseEvent

+ func (e *BaseEvent) Tokens() []Token

type Definition

+ func (d *Definition) Fingerprint() string

+ func (d *Definition) ListenerCount(eventType EventType) int

+ func (d *Definition) RemoveListener(handle *ListenerHandle)

+ type DefinitionMigrationFunc func(ctx context.Context, id, storedFingerprint, currentFingerprint string) error

+ type DueStorage interface

+ ListDue func(ctx context.Context, before time.Time, limit int) ([]string, error)

+ SaveVersionedStateWithDue func(ctx context.Context, id string, marking Marking, context map[string]any, ...) (newVersion int64, err error)

type Event

+ Tokens func() []Token

+ type ExecuteOption func(*executeConfig)

+ func WithMaxRetries(attempts int) ExecuteOption

+ func WithTxSideEffect(effect TxSideEffect) ExecuteOption

+ type ExpressionConstraint struct

+ func NewExpressionConstraint(exprStr string) (*ExpressionConstraint, error)

+ func NewExpressionConstraintWithEnv(exprStr string, envBuilder func(Event) map[string]any) (*ExpressionConstraint, error)

+ func (c *ExpressionConstraint) Validate(event Event) error

+ type ListOptions struct

+ Limit int

+ Offset int

+ type ListableStorage interface

+ ListIDs func(ctx context.Context, opts ListOptions) ([]string, error)

+ type ListenerHandle struct

type Manager

+ func (m *Manager) EvictWorkflow(id string)

+ func (m *Manager) Execute(ctx context.Context, id string, definition *Definition, ...) error

+ func (m *Manager) FireDue(ctx context.Context, id string, definition *Definition, now time.Time, ...) ([]string, error)

+ func (m *Manager) ListDue(ctx context.Context, before time.Time, limit int) ([]string, error)

+ func (m *Manager) ListWorkflowIDs(ctx context.Context, opts ListOptions) ([]string, error)

+ func (m *Manager) ListenerCount(eventType EventType) int

+ func (m *Manager) RemoveListener(handle *ListenerHandle)

+ type ManagerOption func(*Manager)

+ func WithDefinitionMigration(fn DefinitionMigrationFunc) ManagerOption

+ func WithoutRegistryCache() ManagerOption

type Marking

+ AddToken func(place Place, token Token)

+ AllTokens func() map[Place][]Token

+ HasToken func(place Place, id TokenID) bool

+ RemoveToken func(place Place, id TokenID) error

+ TokenCount func(place Place) int

+ TokensAt func(place Place) []Token

+ type Token struct

+ func NewToken(data TokenData) Token

+ func NewTokenWithID(id TokenID, data TokenData) Token

+ func (t *Token) UnmarshalJSON(b []byte) error

+ func (t Token) Data() TokenData

+ func (t Token) EnteredAt() (time.Time, bool)

+ func (t Token) Equal(other Token) bool

+ func (t Token) Get(key string) (any, bool)

+ func (t Token) ID() TokenID

+ func (t Token) MarshalJSON() ([]byte, error)

+ func (t Token) String() string

+ func (t Token) Validate() error

+ func (t Token) With(key string, value any) Token

+ func (t Token) WithData(data TokenData) Token

+ type TokenAggregate struct

+ Avg float64

+ Count int

+ Max float64

+ Min float64

+ Sum float64

+ type TokenData map[string]any

+ type TokenID string

+ type TokenPredicate func(Token) bool

+ type TransactionalDueStorage interface

+ SaveVersionedStateInTxWithDue func(ctx context.Context, id string, marking Marking, context map[string]any, ...) (newVersion int64, err error)

+ type TransactionalStorage interface

+ SaveVersionedStateInTx func(ctx context.Context, id string, marking Marking, context map[string]any, ...) (newVersion int64, err error)

type Transition

+ func (t *Transition) SetTimeoutAfter(d time.Duration)

+ func (t *Transition) TimeoutAfter() (time.Duration, bool)

+ type TxSideEffect func(ctx context.Context, tx any) error

+ type VersionedStorage interface

+ LoadVersionedState func(ctx context.Context, id string) (marking Marking, context map[string]any, version int64, err error)

+ SaveVersionedState func(ctx context.Context, id string, marking Marking, context map[string]any, ...) (newVersion int64, err error)

type Workflow

+ func NewWorkflowFromMarking(name string, definition *Definition, initial Marking, opts ...WorkflowOption) (*Workflow, error)

+ func (w *Workflow) AggregateTokens(pred TokenPredicate, field string) TokenAggregate

+ func (w *Workflow) AllContext() map[string]any

+ func (w *Workflow) AllTokens() map[Place][]Token

+ func (w *Workflow) ApplyTransition(transitionName string) error

+ func (w *Workflow) ApplyTransitionForToken(ctx context.Context, transitionName string, tokenID TokenID) error

+ func (w *Workflow) ApplyTransitionWithContext(ctx context.Context, transitionName string) error

+ func (w *Workflow) CanTransition(transitionName string) error

+ func (w *Workflow) CanTransitionWithContext(ctx context.Context, transitionName string) error

+ func (w *Workflow) ClearPlace(place Place)

+ func (w *Workflow) CountTokens(pred TokenPredicate) int

+ func (w *Workflow) CreateToken(place Place, data TokenData) (Token, error)

+ func (w *Workflow) CreateTokens(place Place, datas []TokenData) ([]Token, error)

+ func (w *Workflow) Due(now time.Time) []Transition

+ func (w *Workflow) FindTokens(pred TokenPredicate) map[Place][]Token

+ func (w *Workflow) GetTokens(place Place) []Token

+ func (w *Workflow) InitialPlaces() []Place

+ func (w *Workflow) ListenerCount(eventType EventType) int

+ func (w *Workflow) NextDue() (time.Time, bool)

+ func (w *Workflow) RemoveListener(handle *ListenerHandle)

+ func (w *Workflow) RemoveToken(place Place, id TokenID) error

+ func (w *Workflow) SelectTokens(place Place, pred TokenPredicate) []Token

+ func (w *Workflow) TokenCount(place Place) int

+ func (w *Workflow) TransformTokens(place Place, pred TokenPredicate, transform func(Token) TokenData) int

+ func (w *Workflow) Version() int64

+ type WorkflowOption func(*Workflow)

+ func WithClock(now func() time.Time) WorkflowOption

v0.0.2

Nov 29, 2025

Changes in this version

+ var ErrInvalidPlace = fmt.Errorf("invalid place")

+ var ErrInvalidTransition = fmt.Errorf("invalid transition")

+ var ErrTransitionNotAllowed = fmt.Errorf("transition not allowed")

+ type BaseEvent struct

+ func NewEvent(ctx context.Context, eventType EventType, transition *Transition, from []Place, ...) *BaseEvent

+ func (e *BaseEvent) Context() context.Context

+ func (e *BaseEvent) From() []Place

+ func (e *BaseEvent) To() []Place

+ func (e *BaseEvent) Transition() *Transition

+ func (e *BaseEvent) Type() EventType

+ func (e *BaseEvent) Workflow() *Workflow

+ type Constraint interface

+ Validate func(Event) error

+ type Definition struct

+ Listeners map[EventType][]interface{}

+ Places []Place

+ Transitions []Transition

+ func NewDefinition(places []Place, transitions []Transition) (*Definition, error)

+ func (d *Definition) AddEventListener(eventType EventType, listener EventListener)

+ func (d *Definition) AddGuardEventListener(listener GuardEventListener)

+ func (d *Definition) AllPlaces() []Place

+ func (d *Definition) AllTransitions() []Transition

+ func (d *Definition) Place(place Place) bool

+ func (d *Definition) RemoveEventListener(eventType EventType, listener interface{})

+ func (d *Definition) Transition(name string) *Transition

+ type Event interface

+ Context func() context.Context

+ From func() []Place

+ To func() []Place

+ Transition func() *Transition

+ Type func() EventType

+ Workflow func() *Workflow

+ type EventListener func(Event) error

+ type EventType string

+ const EventAfterTransition

+ const EventBeforeTransition

+ const EventGuard

+ type GuardEvent struct

+ func NewGuardEvent(ctx context.Context, transition *Transition, from []Place, to []Place, ...) *GuardEvent

+ func (e *GuardEvent) IsBlocking() bool

+ func (e *GuardEvent) SetBlocking(blocking bool)

+ type GuardEventListener func(*GuardEvent) error

+ type GuardListener interface

+ HandleGuardEvent func(*GuardEvent) error

+ type Listener interface

+ HandleEvent func(Event) error

+ type Manager struct

+ Listeners map[EventType][]interface{}

+ func NewManager(registry *Registry, storage Storage) *Manager

+ func (m *Manager) AddEventListener(eventType EventType, listener EventListener)

+ func (m *Manager) AddGuardEventListener(listener GuardEventListener)

+ func (m *Manager) CreateWorkflow(id string, definition *Definition, initialPlace Place) (*Workflow, error)

+ func (m *Manager) DeleteWorkflow(id string) error

+ func (m *Manager) GetWorkflow(id string, definition *Definition) (*Workflow, error)

+ func (m *Manager) LoadWorkflow(id string, definition *Definition) (*Workflow, error)

+ func (m *Manager) RemoveEventListener(eventType EventType, listener interface{})

+ func (m *Manager) SaveWorkflow(id string, wf *Workflow) error

+ type Marking interface

+ AddPlace func(place Place) error

+ HasPlace func(place Place) bool

+ Places func() []Place

+ RemovePlace func(place Place) error

+ SetPlaces func(places []Place)

+ func NewMarking(places []Place) Marking

+ func UnmarshalMarkingJSON(data []byte) (Marking, error)

+ type Place string

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) AddWorkflow(wf *Workflow) error

+ func (r *Registry) HasWorkflow(name string) bool

+ func (r *Registry) ListWorkflows() []string

+ func (r *Registry) RemoveWorkflow(name string) error

+ func (r *Registry) Workflow(name string) (*Workflow, error)

+ type Storage interface

+ DeleteState func(id string) error

+ LoadState func(id string) (places []Place, context map[string]interface{}, err error)

+ SaveState func(id string, places []Place, context map[string]interface{}) error

+ type Transition struct

+ func MustNewTransition(name string, from []Place, to []Place) *Transition

+ func NewTransition(name string, from []Place, to []Place) (*Transition, error)

+ func (t *Transition) AddConstraint(constraint Constraint)

+ func (t *Transition) From() []Place

+ func (t *Transition) Metadata(key string) (interface{}, bool)

+ func (t *Transition) Name() string

+ func (t *Transition) SetMetadata(key string, value interface{})

+ func (t *Transition) To() []Place

+ type Workflow struct

+ func NewWorkflow(name string, definition *Definition, initialPlace Place) (*Workflow, error)

+ func (w *Workflow) AddEventListener(eventType EventType, listener EventListener)

+ func (w *Workflow) AddGuardEventListener(listener GuardEventListener)

+ func (w *Workflow) Apply(targetPlaces []Place) error

+ func (w *Workflow) ApplyWithContext(ctx context.Context, targetPlaces []Place) error

+ func (w *Workflow) Can(to []Place) error

+ func (w *Workflow) CanWithContext(ctx context.Context, to []Place) error

+ func (w *Workflow) Context(key string) (interface{}, bool)

+ func (w *Workflow) CurrentPlaces() []Place

+ func (w *Workflow) Definition() *Definition

+ func (w *Workflow) Diagram() string

+ func (w *Workflow) EnabledTransitions() ([]Transition, error)

+ func (w *Workflow) InitialPlace() Place

+ func (w *Workflow) Marking() Marking

+ func (w *Workflow) Name() string

+ func (w *Workflow) RemoveEventListener(eventType EventType, listener interface{})

+ func (w *Workflow) SetContext(key string, value interface{})

+ func (w *Workflow) SetManager(m *Manager)

+ func (w *Workflow) SetMarking(marking Marking) error

v0.0.1

Jun 23, 2025

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL