event

Documentation

Index

• Variables
• type Builder
  • func NewBuilder[DT any]() Builder[DT]
• type Event
• type Metadata
• type StoreEvent
• type Type
  • func AllTypes() []Type
  • func TypeFromString(s string) Type

Variables

var MissingTypeError = fmt.Errorf("event type is missing")

Types

type Builder

type Builder[DT any] interface {
	WithId(id uuid.UUID) builder[DT]
	WithType(t Type) builder[DT]
	WithData(data DT) builder[DT]
	WithMetadata(data Metadata) builder[DT]
	Build() (ev Event[DT], err error)
	BuildStore() (ev StoreEvent, err error)
}

func NewBuilder

func NewBuilder[DT any]() Builder[DT]

type Event

type Event[DT any] struct {
	Id       uuid.UUID `json:"id"`
	Type     Type      `json:"type"`
	Data     DT        `json:"data"`
	Metadata Metadata  `json:"metadata"`

	Transaction uint64    `json:"transaction"`
	Position    uint64    `json:"position"`
	Created     time.Time `json:"created"`
}

type Metadata

type Metadata struct {
	Stream    string         `json:"stream"`
	EventType Type           `json:"event_type"`
	Version   string         `json:"version"`
	DataType  string         `json:"data_type"`
	Key       string         `json:"key"` //Strictly used for things like getting the cryptoKey
	Extra     map[string]any `json:"extra"`
	Created   time.Time      `json:"created"`
}

type StoreEvent

type StoreEvent struct {
	Id       uuid.UUID `json:"id"`
	Type     Type      `json:"type"`
	Data     any       `json:"data"`
	Metadata Metadata  `json:"metadata"`
}

type Type

type Type string

const (
	Create  Type = "create"
	Update  Type = "update"
	Delete  Type = "delete"
	Invalid Type = "invalid"
)

func AllTypes

func AllTypes() []Type

func TypeFromString

func TypeFromString(s string) Type