webhookapi

type AuthInput struct {
	Mode             string `json:"mode" example:"hmac"`
	Secret           string `json:"secret,omitempty" example:"whsec_example"`
	Algorithm        string `json:"algorithm,omitempty" example:"sha256"`
	SignatureHeader  string `json:"signature_header,omitempty" example:"X-Signature"`
	Encoding         string `json:"encoding,omitempty" example:"hex"`
	Prefix           string `json:"prefix,omitempty" example:"sha256="`
	TimestampHeader  string `json:"timestamp_header,omitempty" example:"X-Timestamp"`
	ToleranceSeconds int    `json:"tolerance_seconds,omitempty" example:"300"`
	Signed           string `json:"signed,omitempty" example:"body"`
	Header           string `json:"header,omitempty" example:"X-Webhook-Token"`
	Username         string `json:"username,omitempty" example:"sender"`
}

type AuthView struct {
	Mode             string     `json:"mode"`
	SecretSet        bool       `json:"secret_set"`
	PreviousUntil    *time.Time `json:"previous_secret_until,omitempty"`
	Algorithm        string     `json:"algorithm,omitempty"`
	SignatureHeader  string     `json:"signature_header,omitempty"`
	Encoding         string     `json:"encoding,omitempty"`
	Prefix           string     `json:"prefix,omitempty"`
	TimestampHeader  string     `json:"timestamp_header,omitempty"`
	ToleranceSeconds int        `json:"tolerance_seconds,omitempty"`
	Signed           string     `json:"signed,omitempty"`
	Header           string     `json:"header,omitempty"`
	Username         string     `json:"username,omitempty"`
}

type Config struct {
	// Service manages sources. nil mounts nothing.
	Service Service
	// Author resolves the acting admin.
	Author func(*http.Request) string
}

type Service interface {
	List(ctx context.Context) ([]whsource.Source, error)
	Get(ctx context.Context, name string) (whsource.Source, whstore.Status, error)
	Create(ctx context.Context, src whsource.Source) (whsource.Source, error)
	Update(ctx context.Context, name string, u whadmin.Update) (whsource.Source, error)
	Delete(ctx context.Context, name string) error
	Overview(ctx context.Context, span, step time.Duration) (whadmin.Overview, error)
}

type SourceDetail struct {
	Source SourceView     `json:"source"`
	Status whstore.Status `json:"status"`
}

type SourceInput struct {
	Name       string          `json:"name,omitempty" example:"esp-events"`
	Enabled    *bool           `json:"enabled,omitempty" example:"true"`
	Connection string          `json:"connection,omitempty" example:"scratch"`
	Auth       AuthInput       `json:"auth"`
	Config     whsource.Config `json:"config"`
	// RotationOverlapSeconds keeps the previous secret valid this long when
	// auth.secret replaces it. Zero ends it at once.
	RotationOverlapSeconds int `json:"rotation_overlap_seconds,omitempty" example:"86400"`
}

type SourceList struct {
	Sources []SourceView `json:"sources"`
}

type SourceRejection struct {
	Source  string    `json:"source"`
	At      time.Time `json:"at"`
	Outcome string    `json:"outcome"`
	Reason  string    `json:"reason"`
}

type SourceStatus struct {
	Name    string `json:"name"`
	Enabled bool   `json:"enabled"`
	// Health is the source's overall state. When more than one applies, the
	// first of disabled, failing, silent, receiving is reported.
	Health     string `json:"health" enums:"receiving,silent,failing,disabled"`
	AuthMode   string `json:"auth_mode"`
	Connection string `json:"connection"`
	Table      string `json:"table"`
	// LastEventAt is when the source last received an event; null when it
	// never has, or not within the windows it still holds.
	LastEventAt *time.Time `json:"last_event_at"`
	// LastHour and LastDay are request counts by outcome.
	LastHour map[string]int64 `json:"last_hour"`
	LastDay  map[string]int64 `json:"last_day"`
	// Pending counts windows owed a compaction; Failing, those whose last
	// attempt failed, with the newest one's error in LastError.
	Pending   int    `json:"pending"`
	Failing   int    `json:"failing"`
	LastError string `json:"last_error,omitempty"`
}

type SourceView struct {
	Name       string `json:"name"`
	Enabled    bool   `json:"enabled"`
	Connection string `json:"connection"`
	// Path is where the sender posts, relative to the platform's address:
	// /hooks/{name}, with the token as a further segment for path_token.
	Path string `json:"path" example:"/hooks/esp-events"`
	// Table is what readers query, in the connection's scratch schema.
	Table     string          `json:"table" example:"webhook_esp_events"`
	Auth      AuthView        `json:"auth"`
	Config    whsource.Config `json:"config"`
	CreatedBy string          `json:"created_by,omitempty"`
	CreatedAt time.Time       `json:"created_at"`
	UpdatedAt time.Time       `json:"updated_at"`
}

type StatusOverview struct {
	GeneratedAt time.Time `json:"generated_at"`
	// Range is the span the series covers: hour or day.
	Range string `json:"range" enums:"hour,day" example:"hour"`
	// From is the series' lower bound: a minute's counts are in the series
	// when the minute is at or after it.
	From time.Time `json:"from"`
	// BucketSeconds is the length of one bucket of the series.
	BucketSeconds int `json:"bucket_seconds" example:"60"`
	// SilentAfterSeconds is how long an enabled source may go without an
	// event before it is reported silent.
	SilentAfterSeconds int               `json:"silent_after_seconds" example:"86400"`
	Sources            []SourceStatus    `json:"sources"`
	Volume             []VolumePoint     `json:"volume"`
	Rejections         []SourceRejection `json:"rejections"`
}

type VolumePoint struct {
	At      time.Time `json:"at"`
	Source  string    `json:"source"`
	Outcome string    `json:"outcome"`
	Count   int64     `json:"count"`
}