events

type Event struct {
	// The specific EventAction that occurred.
	Action EventAction
	// The identity of the user whose action triggered the event.
	JWTUserIdentity domain.Identity
	// The ID of the organization to which the event belongs. May be empty.
	OrgID string
	// The ID of the group to which the event belongs. May be empty.
	GroupID    string
	OccurredAt time.Time
}

type EventAction interface {
	// Encode returns a map representation of the event action.
	Encode() map[string]any

	// Operation returns the string representation of the event action operation.
	Operation() string
}

type EventHandler interface {
	Handle(ctx context.Context, event Event) error
}

type GroupRemoved struct {
	ID       string
	ThingIDs []string
}

type OrgCreated struct {
	ID string
}

type OrgRemoved struct {
	ID string
}

type ProfileCreated struct {
	ID       string
	GroupID  string
	Name     string
	Metadata map[string]any
}

type ProfileRemoved struct {
	ID string
}

type ProfileUpdated struct {
	ID       string
	Name     string
	Config   *domain.ProfileConfig
	Metadata map[string]any
}

type Publisher interface {
	// Publish queues the passed event for delivery by sending it to the buffer
	// channel. It's asynchronous, meaning that it doesn't block the caller
	// and as such returns no errors. If the underlying event buffer is full,
	// the oldest queued event is dropped to make space.
	Publish(ctx context.Context, e Event)

	// Close stops the event drainer goroutine, attempts a final drain,
	// and closes the underlying Redis client.
	Close() error
}

type PublisherConfig struct {
	URL    string
	Stream string

	// MaxLen is the approximate stream retention (XADD MAXLEN ~).
	MaxLen int64

	// BufferSize is the capacity of the buffer channel holding events.
	BufferSize int

	// DrainInitialInterval is the initial XADD retry sleep on failure.
	DrainInitialInterval time.Duration

	// DrainMaxBackoff caps the exponential retry backoff.
	DrainMaxBackoff time.Duration

	// ShutdownDrainTimeout bounds the final drain in Close().
	ShutdownDrainTimeout time.Duration
}

type Subscriber interface {
	// Subscribe subscribes to the event stream and consumes events.
	Subscribe(ctx context.Context, handler EventHandler) error

	// Close gracefully closes event subscriber's connection.
	Close() error
}

type SubscriberConfig struct {
	// URL is the Redis connection URL (e.g. redis://host:6379/0).
	URL string
	// Stream is the name of the Redis stream to read from.
	Stream string
	// Name identifies this subscriber. Used in the cursor key so
	// independent subscribers maintain independent cursors on the same
	// stream.
	Name string
}

type ThingCreated struct {
	ID        string
	GroupID   string
	ProfileID string
	Name      string
	Metadata  map[string]any
}

type ThingGroupAndProfileUpdated struct {
	ID        string
	ProfileID string
	GroupID   string
}

type ThingRemoved struct {
	ID string
}

type ThingUpdated struct {
	ID        string
	ProfileID string
	Name      string
	Metadata  map[string]any
}