workertypes

type BaselineStatus string

type BaselineValue struct {
	Status   BaselineStatus `json:"status"`
	LowDate  *time.Time     `json:"low_date,omitempty"`
	HighDate *time.Time     `json:"high_date,omitempty"`
}

type BrowserName string

type BrowserStatus string

type BrowserValue struct {
	Status  BrowserStatus `json:"status"`
	Version *string       `json:"version,omitempty"`
	Date    *time.Time    `json:"date,omitempty"`
}

type Change[T any] struct {
	From T `json:"from"`
	To   T `json:"to"`
}

type DeliveryMetadata struct {
	EventID     string
	SearchID    string
	Query       string
	Frequency   JobFrequency
	GeneratedAt time.Time
}

type DispatchEventMetadata struct {
	EventID     string
	SearchID    string
	Frequency   JobFrequency
	Query       string
	GeneratedAt time.Time
}

type DocLink struct {
	URL   string  `json:"url"`
	Title *string `json:"title,omitempty"`
	Slug  *string `json:"slug,omitempty"`
}

type Docs struct {
	MDNDocs []DocLink `json:"mdn_docs,omitempty"`
}

type EmailDeliveryJob struct {
	SubscriptionID string
	RecipientEmail string
	ChannelID      string
	Triggers       []JobTrigger
	// SummaryRaw is the opaque JSON payload describing the event.
	SummaryRaw []byte
	// Metadata contains context for links and tracking.
	Metadata DeliveryMetadata
}

type EmailSubscriber struct {
	SubscriptionID string
	UserID         string
	Triggers       []JobTrigger
	EmailAddress   string
	ChannelID      string
}

type EventSummary struct {
	SchemaVersion string             `json:"schemaVersion"`
	Text          string             `json:"text"`
	Categories    SummaryCategories  `json:"categories,omitzero"`
	Truncated     bool               `json:"truncated"`
	Highlights    []SummaryHighlight `json:"highlights"`
}

type FeatureDiffV1SummaryGenerator struct{}

type FeatureRef struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type IncomingEmailDeliveryJob struct {
	EmailDeliveryJob
	// The ID from the queued event for this specific email job.
	// This will be generated by the queuing service.
	// This is different from the EventID in the Metadata which is for the original event that triggered
	// the event producer in the very beginning.
	EmailEventID string
}

type JobFrequency string

type JobTrigger string

type LatestEventInfo struct {
	EventID       string
	StateBlobPath string
}

type NotificationEventCreatedV1 struct {
	ID string `json:"id"`
}

type NotificationEventRequest struct {
	EventID      string
	SearchID     string
	SnapshotType string
	Reasons      []string
	DiffBlobPath string
	Summary      EventSummary
	NewStatePath string
	WorkerID     string
}

type PublishEventRequest struct {
	EventID       string
	StateID       string
	StateBlobPath string
	DiffID        string
	DiffBlobPath  string
	SearchID      string
	Query         string
	Summary       []byte
	Reasons       []Reason
	Frequency     JobFrequency
	GeneratedAt   time.Time
}

type Reason string

type RefreshSearchCommand struct {
	SearchID  string
	Query     string
	Frequency JobFrequency
	Timestamp time.Time
}

type SavedSearchState struct {
	StateBlobPath *string
}

type SavedSearchStateUpdateRequest struct {
	StateBlobPath *string

	UpdateMask []SavedSearchStateUpdateRequestUpdateMask
}

type SavedSearchStateUpdateRequestUpdateMask string

type SearchJob struct {
	ID    string
	Query string
}

type SplitChange struct {
	From FeatureRef   `json:"from"`
	To   []FeatureRef `json:"to"`
}

type SubscriberSet struct {
	Emails []EmailSubscriber
}

type SummaryCategories struct {
	QueryChanged    int `json:"query_changed,omitzero"`
	Added           int `json:"added,omitzero"`
	Removed         int `json:"removed,omitzero"`
	Deleted         int `json:"deleted,omitzero"`
	Moved           int `json:"moved,omitzero"`
	Split           int `json:"split,omitzero"`
	Updated         int `json:"updated,omitzero"`
	UpdatedImpl     int `json:"updated_impl,omitzero"`
	UpdatedRename   int `json:"updated_rename,omitzero"`
	UpdatedBaseline int `json:"updated_baseline,omitzero"`
}

type SummaryHighlight struct {
	Type        SummaryHighlightType `json:"type"`
	FeatureID   string               `json:"feature_id"`
	FeatureName string               `json:"feature_name"`
	Docs        *Docs                `json:"docs,omitempty"`

	// Strongly typed change fields to support i18n and avoid interface{}
	NameChange     *Change[string]                       `json:"name_change,omitempty"`
	BaselineChange *Change[BaselineValue]                `json:"baseline_change,omitempty"`
	BrowserChanges map[BrowserName]*Change[BrowserValue] `json:"browser_changes,omitempty"`
	Moved          *Change[FeatureRef]                   `json:"moved,omitempty"`
	Split          *SplitChange                          `json:"split,omitempty"`
}

type SummaryHighlightType string

type SummaryVisitor interface {
	VisitV1(s EventSummary) error
}