contracts

package

Go to main page

Versions in this module

v0

v0.12.3

Jul 7, 2026

v0.12.2

Jun 27, 2026

v0.12.1

Jun 27, 2026

v0.12.0

Jun 26, 2026

Changes in this version

+ const CronMissedRunSkip

+ const CronOverlapSkip

+ const QueryInvalidationNoticeVersion

+ func RunScheduledJobs(ctx context.Context, jobs []ScheduledJob) error

+ func ValidateScheduledJobs(jobs []ScheduledJob) error

type QueryInvalidationNotice

+ Version int

+ type ScheduledJob struct

+ MissedRunPolicy string

+ Name string

+ OverlapPolicy string

+ Run func(context.Context) error

+ Schedule string

v0.11.0

Jun 22, 2026

v0.10.0

Jun 22, 2026

v0.9.0

Jun 22, 2026

v0.8.0

Jun 22, 2026

Changes in this version

+ func EmitPresentationForAudience[E any](ctx context.Context, event E, audience ...string) error

type EventEnvelope

+ Audience []string

+ func (event EventEnvelope) AudienceLabels() []string

type StoredEventEnvelope

+ Audience []string

v0.7.0

Jun 17, 2026

Changes in this version

+ func InvalidatedEventIDs(invalidations []QueryInvalidation, events []EventEnvelope) []string

+ func InvalidatedQueryTypes(invalidations []QueryInvalidation, events []EventEnvelope) []string

type QueryInvalidationNotice

+ EventIDs []string

v0.6.1

Jun 16, 2026

v0.6.0

Jun 16, 2026

v0.5.0

Jun 15, 2026

Changes in this version

+ const QueryInvalidationPresentationEventType

+ func NewEventID() string

+ func RegisterInvalidation[E, Q any](registry *Registry) error

+ func RunEventWorkerForRoleWithOptions(ctx context.Context, registry *Registry, role Role, source EventSource, ...) error

+ func RunEventWorkerForRoleWithSeenStore(ctx context.Context, registry *Registry, role Role, source EventSource, ...) error

+ func RunEventWorkerForRoleWithSeenStoreAndOptions(ctx context.Context, registry *Registry, role Role, source EventSource, ...) error

+ func RunEventWorkerWithOptions(ctx context.Context, registry *Registry, source EventSource, ...) error

+ func RunEventWorkerWithSeenStore(ctx context.Context, registry *Registry, source EventSource, seen SeenStore) error

+ func RunEventWorkerWithSeenStoreAndOptions(ctx context.Context, registry *Registry, source EventSource, seen SeenStore, ...) error

type CommandEventSink

+ func QueryInvalidationCommandEventSink(fanout PresentationFanout, invalidations []QueryInvalidation) CommandEventSink

type EventEnvelope

+ ID string

+ TraceParent string

+ func EnsureEventID(event EventEnvelope) EventEnvelope

+ func EnsureEventIDs(events []EventEnvelope) []EventEnvelope

+ type EventWorkerBackoff func(EventWorkerRetry) time.Duration

+ func ConstantEventWorkerBackoff(delay time.Duration) EventWorkerBackoff

+ type EventWorkerOption func(*eventWorkerOptions)

+ func WithEventWorkerBackoff(backoff EventWorkerBackoff) EventWorkerOption

+ func WithEventWorkerSeenStore(seen SeenStore) EventWorkerOption

+ type EventWorkerRetry struct

+ Attempt int

+ Cause error

+ EventCount int

+ Role Role

+ type MemorySeenStore struct

+ func NewMemorySeenStore(limit int) *MemorySeenStore

+ func (store *MemorySeenStore) MarkIfNew(ctx context.Context, id string) (bool, error)

+ func (store *MemorySeenStore) MarkSeen(ctx context.Context, id string) error

+ func (store *MemorySeenStore) Seen(ctx context.Context, id string) (bool, error)

type ObservationLabels

+ EventID string

type ObservationName

+ const ObservationWorkerDedupSkip

+ type QueryInvalidation struct

+ EventCategory EventCategory

+ EventType string

+ QueryType string

+ type QueryInvalidationNotice struct

+ Events []string

+ Queries []string

type Registry

+ func (registry *Registry) Invalidations() []QueryInvalidation

type Role

+ const RoleAny

+ type SeenStore interface

+ MarkSeen func(context.Context, string) error

+ Seen func(context.Context, string) (bool, error)

type StoredEventEnvelope

+ ID string

+ TraceParent string

v0.3.0

Jun 12, 2026

Changes in this version

+ func MarshalEventEnvelopeJSON(event EventEnvelope) ([]byte, error)

+ type EventDecoder func(json.RawMessage) (any, error)

+ func JSONEventDecoder[T any]() EventDecoder

type EventEnvelope

+ func DecodeEventEnvelopeJSON(payload []byte, decoders map[string]EventDecoder) (EventEnvelope, error)

+ type StoredEventEnvelope struct

+ Category EventCategory

+ Type string

+ Value json.RawMessage

v0.2.8

Jun 10, 2026

Changes in this version

+ var WorkerLogger func(message string) = func(message string)

v0.2.7

Jun 9, 2026

v0.2.6

Jun 8, 2026

v0.2.5

Jun 8, 2026

v0.2.3

Jun 8, 2026

v0.2.2

Jun 8, 2026

v0.2.1

Jun 8, 2026

v0.2.0

Jun 8, 2026

v0.1.5

Jun 8, 2026

Changes in this version

+ var ErrEventSourceClosed = errors.New("event source closed")

+ func ContractName[T any]() string

+ func DispatchCommandEvents(ctx context.Context, sink CommandEventSink, registry *Registry, role Role, ...) error

+ func EmitDomain[E any](ctx context.Context, event E) error

+ func EmitIntegration[E any](ctx context.Context, event E) error

+ func EmitPresentation[E any](ctx context.Context, event E) error

+ func ExecuteCommandForRole[C, R any](ctx context.Context, registry *Registry, role Role, command C) (R, error)

+ func ExecuteCommandToBrokerForRole[C, R any](ctx context.Context, registry *Registry, broker Broker, role Role, command C) (R, error)

+ func ExecuteCommandToBroker[C, R any](ctx context.Context, registry *Registry, broker Broker, command C) (R, error)

+ func ExecuteCommandToOutboxForRole[C, R any](ctx context.Context, registry *Registry, outbox Outbox, role Role, command C) (R, error)

+ func ExecuteCommandToOutbox[C, R any](ctx context.Context, registry *Registry, outbox Outbox, command C) (R, error)

+ func ExecuteCommandToPresentationFanoutForRole[C, R any](ctx context.Context, registry *Registry, fanout PresentationFanout, role Role, ...) (R, error)

+ func ExecuteCommandToPresentationFanout[C, R any](ctx context.Context, registry *Registry, fanout PresentationFanout, command C) (R, error)

+ func ExecuteCommand[C, R any](ctx context.Context, registry *Registry, command C) (R, error)

+ func ExecuteJobForRole[J any](ctx context.Context, registry *Registry, role Role, job J) error

+ func ExecuteJob[J any](ctx context.Context, registry *Registry, job J) error

+ func ExecuteQueryForRole[Q, R any](ctx context.Context, registry *Registry, role Role, query Q) (R, error)

+ func ExecuteQuery[Q, R any](ctx context.Context, registry *Registry, query Q) (R, error)

+ func Is(err error, kind ErrorKind) bool

+ func PublishDomainForRole[E any](ctx context.Context, registry *Registry, role Role, event E) error

+ func PublishDomain[E any](ctx context.Context, registry *Registry, event E) error

+ func PublishEnvelope(ctx context.Context, registry *Registry, event EventEnvelope) error

+ func PublishEnvelopeForRole(ctx context.Context, registry *Registry, role Role, event EventEnvelope) error

+ func PublishEnvelopes(ctx context.Context, registry *Registry, events []EventEnvelope) error

+ func PublishEnvelopesForRole(ctx context.Context, registry *Registry, role Role, events []EventEnvelope) error

+ func PublishEventsToBroker(ctx context.Context, broker Broker, events []EventEnvelope) error

+ func PublishIntegrationForRole[E any](ctx context.Context, registry *Registry, role Role, event E) error

+ func PublishIntegration[E any](ctx context.Context, registry *Registry, event E) error

+ func PublishPresentationForRole[E any](ctx context.Context, registry *Registry, role Role, event E) error

+ func PublishPresentation[E any](ctx context.Context, registry *Registry, event E) error

+ func RegisterCommand[C, R any](registry *Registry, handler CommandHandler[C, R], roles ...Role) error

+ func RegisterDomainEvent[E any](registry *Registry, handler EventHandler[E], roles ...Role) error

+ func RegisterIntegrationEvent[E any](registry *Registry, handler EventHandler[E], roles ...Role) error

+ func RegisterJob[J any](registry *Registry, handler JobHandler[J], roles ...Role) error

+ func RegisterPresentationEvent[E any](registry *Registry, handler EventHandler[E], roles ...Role) error

+ func RegisterQuery[Q, R any](registry *Registry, handler QueryHandler[Q, R], roles ...Role) error

+ func RunEventWorker(ctx context.Context, registry *Registry, source EventSource) error

+ func RunEventWorkerForRole(ctx context.Context, registry *Registry, role Role, source EventSource) error

+ func SendPresentationEventsToFanout(ctx context.Context, fanout PresentationFanout, events []EventEnvelope) error

+ type Broker interface

+ PublishEvents func(context.Context, []EventEnvelope) error

+ type CommandEventSink interface

+ HandleCommandEvents func(context.Context, *Registry, Role, []EventEnvelope) error

+ func BrokerCommandEventSink(broker Broker) CommandEventSink

+ func CompositeCommandEventSink(sinks ...CommandEventSink) CommandEventSink

+ func InProcessCommandEventSink() CommandEventSink

+ func OutboxCommandEventSink(outbox Outbox) CommandEventSink

+ func PresentationFanoutCommandEventSink(fanout PresentationFanout) CommandEventSink

+ type CommandHandler func(context.Context, C) (R, error)

+ type Error struct

+ Cause error

+ Contract string

+ Kind ErrorKind

+ Message string

+ func (err Error) Error() string

+ func (err Error) Unwrap() error

+ type ErrorKind string

+ const ErrDuplicateHandler

+ const ErrMissingHandler

+ const ErrNilHandler

+ const ErrNoEventRecorder

+ const ErrRoleNotAllowed

+ const ErrSubscriberFailed

+ const ErrUnsupportedHandler

+ type EventBatch struct

+ Ack func(context.Context) error

+ Events []EventEnvelope

+ Nack func(context.Context, error) error

+ type EventCategory string

+ const DomainEvent

+ const IntegrationEvent

+ const PresentationEvent

+ type EventEnvelope struct

+ Category EventCategory

+ Type string

+ Value any

+ func CaptureCommandEventsForRole[C, R any](ctx context.Context, registry *Registry, role Role, command C) (R, []EventEnvelope, error)

+ func CaptureCommandEvents[C, R any](ctx context.Context, registry *Registry, command C) (R, []EventEnvelope, error)

+ func (event EventEnvelope) Observation(name ObservationName) Observation

+ func (event EventEnvelope) ObservationForRole(name ObservationName, role Role) Observation

+ func (event EventEnvelope) ObservationLabels() ObservationLabels

+ type EventHandler func(context.Context, E) error

+ type EventSource interface

+ ReceiveEventBatch func(context.Context) (EventBatch, error)

+ type JobHandler func(context.Context, J) error

+ type Kind string

+ const Command

+ const Event

+ const Job

+ const Query

+ type Metadata struct

+ EventCategory EventCategory

+ Handlers int

+ Kind Kind

+ Result string

+ Roles []Role

+ Type string

+ func (metadata Metadata) Observation(name ObservationName) Observation

+ func (metadata Metadata) ObservationForRole(name ObservationName, role Role) Observation

+ func (metadata Metadata) ObservationLabels() ObservationLabels

+ type Observation struct

+ Labels ObservationLabels

+ Name ObservationName

+ func NewObservation(name ObservationName, labels ObservationLabels) Observation

+ type ObservationLabels struct

+ Contract string

+ EventCategory EventCategory

+ Handlers int

+ Kind Kind

+ Result string

+ Role Role

+ Roles []Role

+ type ObservationName string

+ const ObservationCaptureCommand

+ const ObservationExecuteCommand

+ const ObservationExecuteJob

+ const ObservationExecuteQuery

+ const ObservationPublishBrokerEvents

+ const ObservationPublishEvent

+ const ObservationRegisterCommand

+ const ObservationRegisterEvent

+ const ObservationRegisterJob

+ const ObservationRegisterQuery

+ const ObservationSendPresentationEvents

+ const ObservationStoreCommandEvents

+ const ObservationWorkerAckEventBatch

+ const ObservationWorkerNackEventBatch

+ const ObservationWorkerReceiveEventBatch

+ type Outbox interface

+ StoreEvents func(context.Context, []EventEnvelope) error

+ type PresentationFanout interface

+ SendPresentationEvents func(context.Context, []EventEnvelope) error

+ type QueryHandler func(context.Context, Q) (R, error)

+ type Registry struct

+ func NewRegistry() *Registry

+ func (registry *Registry) Contracts() []Metadata

+ func (registry *Registry) ContractsForRole(role Role) []Metadata

+ type Role string

+ const RoleAPI

+ const RoleAdmin

+ const RoleCron

+ const RoleWeb

+ const RoleWorker

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