notify

type DeliveryResult struct {
	// Status is a target-specific delivery status such as sent or failed.
	Status string

	// StatusCode is the target response status code when one exists.
	StatusCode int

	// Response contains target-specific response details.
	//
	// Generic Notifykit loggers do not log this value because target responses
	// may contain sensitive data such as webhook URLs, tokens, echoed payloads,
	// or authentication diagnostics.
	Response string
}

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

type ManagerOption func(*managerConfig)

type Notification interface {
	ID() string
	Data(receiver string, customData map[string]any, subject string) any
}

type Notifier interface {
	Enqueue(ctx context.Context, notification Notification) (string, error)
}

type Payload struct {
	// Notification is the original application notification.
	Notification Notification

	// Receiver is the receiver display name passed to template data.
	Receiver string

	// CustomData contains receiver-scoped custom template data.
	CustomData map[string]any
}

type Receiver struct {
	// ID is the receiver map key used for routing.
	//
	// NewManager and Send fill this from the Receivers map key when it is unset.
	ID ReceiverID

	// Name is the display name passed to notification template data.
	//
	// NewManager and Send default Name to the receiver ID when it is unset.
	Name string

	// Retry controls retry behavior for all targets on this receiver.
	Retry RetryConfig

	// Targets contains the delivery targets for this receiver.
	Targets []Target

	// CustomData contains receiver-scoped custom template data.
	CustomData map[string]any
}

type ReceiverID string

type ReceiverRouter interface {
	ReceiverIDs() []ReceiverID
}

type Receivers map[ReceiverID]*Receiver

type RetryConfig struct {
	// Count is the number of retries after the initial attempt.
	//
	// For example, Count 2 means up to 3 total attempts.
	Count int

	// Backoff is the initial wait duration before retrying.
	//
	// Each later retry wait doubles this duration until MaxBackoff caps it.
	// If Backoff is zero or negative, retries happen immediately.
	Backoff time.Duration

	// MaxBackoff caps retry wait durations.
	//
	// If MaxBackoff is zero or negative, retry waits are not capped.
	MaxBackoff time.Duration
}

type Target interface {
	Send(ctx context.Context, payload Payload) (DeliveryResult, error)
	Type() string
}