notification

package module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 19, 2026 License: MIT Imports: 13 Imported by: 0

README

notification — Hyperrr Pluggable Notification Module

Go Reference

This repository contains the standalone, pluggable notification and messaging providers for the Hyperrr engine. It includes support for SMTP email sending, Twilio WhatsApp integration, multi-channel routing, and multiple sender profiles (e.g. orders@mango.in, support@mango.in).

📬 Features

  • SMTP Email Provider: Sends HTML and plain-text emails via standard net/smtp.
  • Multi-profile Sender Support: Dynamically routes messages using different sender profiles and credentials depending on context (e.g., support vs. sales vs. transactional notifications).
  • Twilio WhatsApp Provider: Integrates with Twilio for WhatsApp messaging campaigns and notifications.
  • Multi-Channel Router: Intelligently routes notifications to email, WhatsApp, or both based on preferences and recipient endpoints.
  • Event-Native Workflows: Reacts automatically to platform events (such as user registrations or order completion status) via the Hyperrr event bus.

🛠️ Usage

This module is imported by the core Hyperrr engine and registers its notification models, routes, and step handlers during runtime initialization.

To learn more about how to configure notification profiles or build custom channels, see the Hyperrr Developer Guide.

Documentation

Overview

Package notification implements pluggable notification providers including SMTP email and Twilio WhatsApp, supporting multiple sender profiles and event-native routing.

Licensed under the MIT License.

Index

Constants

View Source 
const (
	StatusPending NotificationStatus = "PENDING"
	StatusSent    NotificationStatus = "SENT"
	StatusFailed  NotificationStatus = "FAILED"

	ChannelEmail    NotificationChannel = "EMAIL"
	ChannelSMS      NotificationChannel = "SMS"
	ChannelWhatsapp NotificationChannel = "WHATSAPP"
)
View Source 
const Version = "0.4.0"

Version is the current version of the Hyperrr Notification Modules.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateEventTriggerInput 

type CreateEventTriggerInput struct {
	Namespace         string  `json:"namespace"`
	Event             string  `json:"event"`
	Channel           string  `json:"channel"`
	Sender            *string `json:"sender,omitempty"`
	RecipientTemplate string  `json:"recipientTemplate"`
	SubjectTemplate   *string `json:"subjectTemplate,omitempty"`
	BodyTemplate      string  `json:"bodyTemplate"`
}

type EventTrigger 

type EventTrigger struct {
	ID                string `gorm:"primaryKey" json:"id"`
	Namespace         string `gorm:"index;not null" json:"namespace"`
	Event             string `gorm:"not null" json:"event"`
	Channel           string `gorm:"not null" json:"channel"`
	Sender            string `json:"sender"`
	RecipientTemplate string `gorm:"not null" json:"recipient_template"`
	SubjectTemplate   string `json:"subject_template"`
	BodyTemplate      string `gorm:"not null" json:"body_template"`
	Enabled           bool   `gorm:"default:true" json:"enabled"`
}

type MockProvider 

type MockProvider struct {
	ShouldFail bool
}

MockProvider is a simple provider for testing and development.

func (*MockProvider) Send 

func (m *MockProvider) Send(ctx context.Context, n *Notification) error

type Module 

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

Module implements the mdk.Module interface for Notification.

func NewModule 

func NewModule(provider Provider) *Module

func (*Module) CancelScheduledNotification 

func (m *Module) CancelScheduledNotification(ctx context.Context, id string) (bool, error)

func (*Module) CreateEventTrigger 

func (m *Module) CreateEventTrigger(ctx context.Context, input CreateEventTriggerInput) (*EventTrigger, error)

func (*Module) DeleteEventTrigger 

func (m *Module) DeleteEventTrigger(ctx context.Context, id string) (bool, error)

func (*Module) FieldResolvers 

func (m *Module) FieldResolvers() map[string]any

func (*Module) ID 

func (m *Module) ID() string

func (*Module) Init 

func (m *Module) Init(ctx context.Context, rt mdk.Runtime) error

func (*Module) ListEventTriggers 

func (m *Module) ListEventTriggers(ctx context.Context) ([]*EventTrigger, error)

func (*Module) ListNotifications 

func (m *Module) ListNotifications(ctx context.Context, recipient *string) ([]*Notification, error)

func (*Module) ListScheduledNotifications 

func (m *Module) ListScheduledNotifications(ctx context.Context) ([]*ScheduledNotification, error)

func (*Module) Models 

func (m *Module) Models() []any

func (*Module) Mutations 

func (m *Module) Mutations() map[string]any

func (*Module) Queries 

func (m *Module) Queries() map[string]any

func (*Module) Repo 

func (m *Module) Repo() *Repository

func (*Module) Routes 

func (m *Module) Routes() []mdk.Route

func (*Module) ScheduleNotification 

func (m *Module) ScheduleNotification(ctx context.Context, input ScheduleNotificationInput) (*ScheduledNotification, error)

func (*Module) SendNotification 

func (m *Module) SendNotification(ctx context.Context, input any) (any, error)

SendNotification executes the notification delivery via the provider.

func (*Module) SendNotificationStep 

func (m *Module) SendNotificationStep(sCtx mdk.StepContext) mdk.StepResult

SendNotificationStep wraps SendNotification to mdk.StepHandler.

func (*Module) Shutdown 

func (m *Module) Shutdown(ctx context.Context) error

type MultiChannelRoutingProvider 

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

MultiChannelRoutingProvider routes notifications to appropriate providers based on channel.

func NewMultiChannelRoutingProvider 

func NewMultiChannelRoutingProvider(email, whatsapp Provider) *MultiChannelRoutingProvider

func (*MultiChannelRoutingProvider) Send 

func (m *MultiChannelRoutingProvider) Send(ctx context.Context, n *Notification) error

type Notification 

type Notification struct {
	ID        string              `gorm:"primaryKey" json:"id"`
	Sender    string              `json:"sender"` // e.g. "orders@mango.in", "support@mango.in" or "+14155552671"
	Recipient string              `gorm:"index;not null" json:"recipient"`
	Channel   NotificationChannel `gorm:"not null" json:"channel"`
	Subject   string              `json:"subject"`
	Body      string              `json:"body"`
	Status    NotificationStatus  `gorm:"not null" json:"status"`
	CreatedAt time.Time           `json:"created_at"`
	UpdatedAt time.Time           `json:"updated_at"`
	DeletedAt gorm.DeletedAt      `gorm:"index" json:"-"`
}

Notification represents a message sent to a user.

type NotificationChannel 

type NotificationChannel string

type NotificationStatus 

type NotificationStatus string

type Provider 

type Provider interface {
	Send(ctx context.Context, n *Notification) error
}

Provider defines the interface for sending notifications.

type Repository 

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

Repository handles data access for notifications.

func NewRepository 

func NewRepository(database *gorm.DB) *Repository

NewRepository creates a new Repository.

func (*Repository) GetByID 

func (r *Repository) GetByID(ctx context.Context, id string) (*Notification, error)

GetByID retrieves a notification by its ID.

func (*Repository) List 

func (r *Repository) List(ctx context.Context, recipient string) ([]*Notification, error)

List retrieves all notifications, optionally filtered by recipient.

func (*Repository) Save 

func (r *Repository) Save(ctx context.Context, n *Notification) error

Save persists a notification to the database.

type SMTPConfig 

type SMTPConfig struct {
	Host     string `json:"smtp_host"`
	Port     int    `json:"smtp_port"`
	Username string `json:"smtp_user"`
	Password string `json:"smtp_pass"`
	From     string `json:"smtp_from"`
}

SMTPConfig holds SMTP server credentials.

type SMTPProvider 

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

SMTPProvider implements email delivery using net/smtp.

func NewSMTPProvider 

func NewSMTPProvider(defaultConfig SMTPConfig, senders map[string]SMTPConfig) *SMTPProvider

func (*SMTPProvider) Send 

func (s *SMTPProvider) Send(ctx context.Context, n *Notification) error

type ScheduleNotificationInput 

type ScheduleNotificationInput struct {
	Sender         *string   `json:"sender,omitempty"`
	Recipient      string    `json:"recipient"`
	Channel        string    `json:"channel"`
	Subject        *string   `json:"subject,omitempty"`
	Body           string    `json:"body"`
	ScheduledAt    time.Time `json:"scheduledAt"`
	CronExpression *string   `json:"cronExpression,omitempty"`
}

type ScheduledNotification 

type ScheduledNotification struct {
	ID             string     `gorm:"primaryKey" json:"id"`
	Sender         string     `json:"sender"`
	Recipient      string     `gorm:"not null" json:"recipient"`
	Channel        string     `gorm:"not null" json:"channel"`
	Subject        string     `json:"subject"`
	Body           string     `gorm:"not null" json:"body"`
	ScheduledAt    time.Time  `gorm:"index" json:"scheduled_at"`
	CronExpression string     `json:"cron_expression"`
	Status         string     `gorm:"default:'PENDING'" json:"status"`
	LastRunAt      *time.Time `json:"last_run_at,omitempty"`
	CreatedAt      time.Time  `json:"created_at"`
	UpdatedAt      time.Time  `json:"updated_at"`
}

type TwilioWhatsappConfig 

type TwilioWhatsappConfig struct {
	AccountSID string `json:"twilio_sid"`
	AuthToken  string `json:"twilio_token"`
	From       string `json:"twilio_from"`
}

TwilioWhatsappConfig holds Twilio API credentials.

type TwilioWhatsappProvider 

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

TwilioWhatsappProvider implements WhatsApp message delivery using Twilio REST API.

func NewTwilioWhatsappProvider 

func NewTwilioWhatsappProvider(defaultConfig TwilioWhatsappConfig, senders map[string]TwilioWhatsappConfig) *TwilioWhatsappProvider

func (*TwilioWhatsappProvider) Send 

func (w *TwilioWhatsappProvider) Send(ctx context.Context, n *Notification) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.