domain-notifications

Notification orchestration across multiple channels

What it is for

domain-notifications: Notification orchestration across multiple channels

Overview

This crate provides a notification system that delivers messages about events through multiple channels. It handles notification creation, delivery tracking, user preferences, and templates.

Important: This is an orchestration crate, not an email crate. Actual delivery is handled by channel-specific adapters.

Layer

Domain - depends on: foundation-basemodels

Key Types

• Notification - A notification to be delivered
• NotificationTemplate - Template for consistent messaging
• NotificationPreference - User channel preferences
• DeliveryAttempt - Record of a delivery attempt
• NotificationService - High-level business operations
• DeliveryBackend - Trait for channel delivery adapters
• InAppBackend - No-op backend for in-app notifications

Channels

• In-app (database + websocket)
• Email (adapter)
• SMS (adapter)
• Webhook
• Push notifications

Example

use domain_notifications::{
NotificationService, CreateNotificationRequest, NotificationChannel, EntityRef
};

let service = NotificationService::new(pool);

// Create a notification
let (notification, event) = service.create_notification(CreateNotificationRequest {
tenant_id,
recipient_party_id: user_id,
event_type: "comment.mentioned".to_string(),
title: "You were mentioned".to_string(),
body: "Someone mentioned you in a comment".to_string(),
channel: NotificationChannel::InApp,
entity_type: Some("Comment".to_string()),
entity_id: Some(comment_id),
data: None,
idempotency_key: Some(format!("mention-{}-{}", comment_id, user_id)),
}).await?;

// Check user preferences before delivery
let can_deliver = service.can_deliver(
user_id, tenant_id, NotificationChannel::Email, "comment.mentioned"
).await?;

// Mark as read
service.mark_read(notification.id).await?;

// Get unread count
let unread = service.count_unread(tenant_id, user_id).await?;

Capabilities

No public items.

How to use it

No examples/ target and no doctest in this crate's rustdoc. The tests listed under Verification are the closest executable usage.

Module structure

No public modules: the crate root is its whole surface.

Public surface

No public items.

Re-exports. Exported here, defined elsewhere.

Boundary

Reaches into foundation.

Shares tier domain with 41 other crates: domain-agreements, domain-ai-report, domain-billing, domain-catalog, domain-classify, domain-comments, domain-competitive-intel, domain-contact, … (41 total).

_What this crate deliberately does NOT own is a judgment. No committed registry records one for it, so none is stated here._

Where it sits

Tier flow. Which tiers this crate's own edges cross.

flowchart LR
  n_domain["domain"] --> n_foundation["foundation"]

Dependencies

Runtime, in this workspace.

Runtime, from outside the workspace.

Development, from outside the workspace.

Build. None.

Depended on by. 2 workspace crates.

Signal flow — what reaches this crate, and what it reaches.

flowchart LR
  n_application_notifications["application-notifications"] -->|uses| SELF
  n_platform_privacy_scan_api["platform-privacy-scan-api"] -->|uses| SELF
  SELF["domain-notifications"]
  SELF -->|runtime| n_foundation_basemodels["foundation-basemodels"]
  classDef self fill:#1f883d,stroke:#1f883d,color:#fff;
  class SELF self;

Feature flags

No Cargo features are defined: every capability is unconditional, so no consumer can receive a half-wired crate.

Targets

Error model

No public error type was detected: no public item declares a type named *Error, and no public signature returns one.

Operational characteristics

No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.

Configuration

No environment variable is read with a literal name anywhere in this crate. A variable whose key is computed at run time cannot be listed here, and is not claimed to be absent.

Related capabilities

2 workspace crates depend on this one: application-notifications, platform-privacy-scan-api.

Verification

What the tests establish, by name:

• test_delivery_result_chained — src/delivery.rs
• test_delivery_result_success — src/delivery.rs
• test_delivery_result_with_external_id — src/delivery.rs
• test_delivery_result_with_response — src/delivery.rs
• test_in_app_backend_channel — src/delivery.rs
• test_in_app_backend_deliver — src/delivery.rs
• test_in_app_backend_is_available — src/delivery.rs
• test_channel_disabled — src/errors.rs
• test_delivery_failed — src/errors.rs
• test_duplicate_notification — src/errors.rs
• test_in_quiet_hours — src/errors.rs
• test_invalid_status_transition — src/errors.rs
• test_notification_not_found — src/errors.rs
• test_template_not_found — src/errors.rs
• test_validation_error — src/errors.rs
• test_delivery_attempted_event — src/events.rs
• test_event_serialization — src/events.rs
• test_notification_created_event — src/events.rs
• test_notification_delivered_event — src/events.rs
• test_notification_failed_event — src/events.rs
• test_notification_read_event — src/events.rs
• test_preferences_updated_event — src/events.rs
• test_all_channels — src/lib.rs
• test_delivery_attempt_failure — src/lib.rs
• test_delivery_attempt_skipped — src/lib.rs
• test_delivery_attempt_success — src/lib.rs
• test_notification_channel_parsing — src/lib.rs
• test_notification_events — src/lib.rs
• test_notification_idempotency — src/lib.rs
• test_notification_mark_read — src/lib.rs
• _… 20 more_

Documentation coverage

Metrics

pie showData
    title Rust source composition
    "Code" : 2111
    "Blank or comment" : 745

Generation

Rendered by tools-corpus corpus readme from repository evidence alone, renderer schema 2, lexicon current. No model, network service or database was consulted. Regenerate with tools-corpus corpus readme --write; verify with --check.