hub

type ChangeEvent struct {
	Op string `json:"op"` // "upsert" | "delete"
	// Item is set for an upsert. It is typed any so a host can send the shape its
	// own API already uses for an item without this package knowing it.
	Item any `json:"item,omitempty"`
	// ID is set for a delete, and Kind is the deleted item's kind: a delete has
	// nothing else on the wire, and a client cannot tell which category region a
	// deleted item belonged to without it.
	ID   string `json:"id,omitempty"`
	Kind string `json:"kind,omitempty"`
}

type Frame struct {
	Type FrameType       `json:"type"`
	Data json.RawMessage `json:"data"`
}

type FrameType string

type HitEvent struct {
	ItemIDs []string `json:"itemIds"`
	Query   string   `json:"query"`
	// Kind is the search's kind filter, usually empty: not a per-item kind.
	Kind string `json:"kind,omitempty"`
	// Kinds is the kind of each item, parallel to ItemIDs, so a client can place
	// a hit by category without having the item itself. A client that finds it
	// absent or shorter than ItemIDs must fall back to behaviour that needs no
	// kind.
	Kinds []string `json:"kinds,omitempty"`
}

type Hub struct {
	// contains filtered or unexported fields
}

type Transport interface {
	PublishHit(HitEvent)
	PublishChange(ChangeEvent)
}