GitHub - muhittincamdali/iOS-Notification-Framework: 🔔 Complete push notification framework for iOS with rich notifications and actions

╔══════════════════════════════════════════════════════════════════════════════╗
║                                                                              ║
║   ███╗   ██╗ ██████╗ ████████╗██╗███████╗██╗ ██████╗ █████╗ ████████╗██╗    ║
║   ████╗  ██║██╔═══██╗╚══██╔══╝██║██╔════╝██║██╔════╝██╔══██╗╚══██╔══╝██║    ║
║   ██╔██╗ ██║██║   ██║   ██║   ██║█████╗  ██║██║     ███████║   ██║   ██║    ║
║   ██║╚██╗██║██║   ██║   ██║   ██║██╔══╝  ██║██║     ██╔══██║   ██║   ██║    ║
║   ██║ ╚████║╚██████╔╝   ██║   ██║██║     ██║╚██████╗██║  ██║   ██║   ██║    ║
║   ╚═╝  ╚═══╝ ╚═════╝    ╚═╝   ╚═╝╚═╝     ╚═╝ ╚═════╝╚═╝  ╚═╝   ╚═╝   ╚═╝    ║
║                                                                              ║
║                          ██╗  ██╗██╗████████╗                                ║
║                          ██║ ██╔╝██║╚══██╔══╝                                ║
║                          █████╔╝ ██║   ██║                                   ║
║                          ██╔═██╗ ██║   ██║                                   ║
║                          ██║  ██╗██║   ██║                                   ║
║                          ╚═╝  ╚═╝╚═╝   ╚═╝                                   ║
║                                                                              ║
╚══════════════════════════════════════════════════════════════════════════════╝

The most comprehensive notification framework for iOS. Everything you need for local, remote, and rich notifications.

Features • Quick Start • Installation • Documentation • Examples

🏆 Why NotificationKit?

Feature	NotificationKit	Others
Local Notifications	✅	✅
Remote Push	✅	⚠️
Rich Media (Images, Video, GIF)	✅	⚠️
Interactive Actions	✅	✅
A/B Testing	✅	❌
Analytics & Insights	✅	❌
Quiet Hours	✅	❌
Rate Limiting	✅	❌
Notification Channels	✅	❌
Deep Linking	✅	⚠️
Delivery Optimization	✅	❌
User Preferences	✅	❌
Location-based	✅	⚠️
Personalization	✅	❌

✨ Features

🔔 Core Notifications

Type-Safe Builder Pattern — Compile-time safety with fluent API
Rich Media Support — Images, videos, GIFs, and audio attachments
Interactive Actions — Buttons, text input, and quick replies
Smart Scheduling — Time interval, calendar, and location triggers
iOS 15+ Focus Modes — Time Sensitive and Critical alerts

📊 Analytics & Optimization

Built-in Analytics — Track opens, interactions, and dismissals
Delivery Optimization — ML-powered optimal timing
A/B Testing — Test different notification variants
Engagement Metrics — Open rates, response times, heatmaps

🎛️ Advanced Controls

Quiet Hours — Respect user's do-not-disturb preferences
Rate Limiting — Prevent notification fatigue
Notification Channels — Android-style channel management
User Preferences — Per-category and topic subscriptions

🔗 Integration

Deep Linking — Navigate users to specific content
Personalization — Dynamic content with templates
Location-based — Geofence notifications
Remote Push Ready — Full APNs integration support

🚀 Quick Start

1. Configure on App Launch

import NotificationKit

@main
struct MyApp: App {
    init() {
        NotificationKit.configure { config in
            config.enableAnalytics = true
            config.quietHours = .nightTime  // 10 PM - 8 AM
            config.rateLimiting = .moderate  // 5/hour, 20/day
            config.urlScheme = "myapp"
        }
    }
}

2. Request Permission

// Standard authorization
try await NotificationKit.shared.requestAuthorization()

// Provisional (quiet) authorization
try await NotificationKit.shared.requestProvisionalAuthorization()

3. Schedule a Notification

try await NotificationKit.shared.schedule {
    Notification(id: "welcome")
        .title("Welcome! 👋")
        .body("Thanks for downloading our app")
        .sound(.default)
        .trigger(after: .seconds(5))
}

That's it! 🎉

📦 Installation

Swift Package Manager

Add to your Package.swift:

dependencies: [
    .package(url: "https://github.com/muhittincamdali/iOS-Notification-Framework.git", from: "2.0.0")
]

Or in Xcode: File → Add Package Dependencies → Enter the repository URL.

Requirements

Platform	Minimum Version
iOS	15.0+
macOS	13.0+
tvOS	15.0+
watchOS	8.0+
visionOS	1.0+
Swift	5.9+

🎯 Core Concepts

Notification Builder

let notification = Notification(id: "promo-123")
    .title("Flash Sale! 🔥")
    .subtitle("24 hours only")
    .body("Up to 50% off on all items")
    .sound(.default)
    .badge(1)
    .category("PROMO")
    .thread("sales")
    .relevanceScore(0.9)
    .timeSensitive()

Trigger Types

// Immediate
.trigger(.immediate)

// After time interval
.trigger(after: .minutes(30))
.trigger(after: .hours(2))
.trigger(after: .days(1))

// Calendar-based
.daily(at: 9, minute: 0)           // Every day at 9 AM
.weekly(on: .monday, at: 10)       // Every Monday at 10 AM
.monthly(on: 1, at: 9)             // 1st of every month
.at(date: specificDate)            // Specific date

// Location-based (requires CoreLocation)
.trigger(.geofence(
    latitude: 37.7749,
    longitude: -122.4194,
    radius: 100,
    identifier: "office",
    onEntry: true
))

Rich Notifications

// Image attachment
try await NotificationKit.shared.schedule {
    Notification(id: "product")
        .title("New Arrival!")
        .body("Check out our latest product")
        .image(productImageURL)
}

// Video attachment
.video(videoURL)

// GIF attachment
.gif(gifURL)

// Audio attachment
.audio(audioURL)

Interactive Categories

// Register category
NotificationKit.shared.register(
    category: NotificationCategory(identifier: "MESSAGE")
        .action(.reply)
        .action(.view)
        .action(
            NotificationAction(identifier: "MARK_READ", title: "Mark as Read")
        )
)

// Use in notification
Notification(id: "msg-1")
    .title("New Message")
    .body("Hey, how are you?")
    .category("MESSAGE")

🚀 Advanced Features

📊 Analytics

// Access analytics
let stats = NotificationKit.shared.analytics.stats

print("Scheduled: \(stats.scheduledCount)")
print("Opened: \(stats.interactedCount)")
print("Open Rate: \(NotificationKit.shared.analytics.openRate * 100)%")

// Get action distribution
let actions = NotificationKit.shared.analytics.actionDistribution

// Export analytics
let jsonData = try NotificationKit.shared.analytics.exportAsJSON()

🧪 A/B Testing

// Create experiment
let experiment = ABExperiment.titleTest(
    id: "onboarding-title",
    name: "Onboarding Title Test",
    titleA: "Welcome to the app!",
    titleB: "You're going to love this!"
)

NotificationKit.shared.abTesting.createExperiment(experiment)

// Use in notification
Notification(id: "onboarding")
    .title("Default Title")  // Will be replaced by variant
    .body("Start exploring")
    .abTest("onboarding-title")

🌙 Quiet Hours

// Configure quiet hours
NotificationKit.configure { config in
    // Preset: Night time (10 PM - 8 AM)
    config.quietHours = .nightTime
    
    // Custom configuration
    config.quietHours = QuietHoursConfiguration(
        startTime: "23:00",
        endTime: "07:00",
        activeDays: [.monday, .tuesday, .wednesday, .thursday, .friday]
    )
}

// Bypass for urgent notifications
Notification(id: "urgent")
    .title("Security Alert")
    .bypassQuietHours()
    .critical()

📈 Rate Limiting

// Configure rate limiting
NotificationKit.configure { config in
    // Presets
    config.rateLimiting = .conservative  // 2/hour, 10/day
    config.rateLimiting = .moderate      // 5/hour, 20/day
    config.rateLimiting = .relaxed       // 10/hour, 50/day
    
    // Custom
    config.rateLimiting = RateLimitingConfiguration(
        maxPerHour: 3,
        maxPerDay: 15
    )
}

// Bypass for important notifications
Notification(id: "important")
    .title("Order Update")
    .bypassRateLimit()

📺 Notification Channels

// Create channels
NotificationKit.shared.channels.create([
    .general,
    .promotions,
    .social,
    .reminders,
    NotificationChannel(
        id: "orders",
        name: "Order Updates",
        description: "Shipping and delivery updates",
        importance: .high
    )
])

// Use channel
Notification(id: "order-shipped")
    .title("Order Shipped!")
    .channel("orders")

// Check/toggle channel
let isEnabled = NotificationKit.shared.channels.isChannelEnabled("promotions")
NotificationKit.shared.channels.disable(id: "promotions")

🔗 Deep Linking

// Register deep link handlers
NotificationKit.shared.deepLinks.register(path: "/product/*") { context in
    let productId = context.path.split(separator: "/").last
    // Navigate to product
}

NotificationKit.shared.deepLinks.register(path: "/settings") { context in
    // Navigate to settings
}

// Use in notification
Notification(id: "product-update")
    .title("New Features!")
    .deepLink("/product/123?ref=notification")

// Build URLs
let url = NotificationKit.shared.deepLinks.buildURL(
    path: "/product/456",
    params: ["source": "push"]
)

👤 User Preferences

// Get/set preferences
let prefs = NotificationKit.shared.preferences

// Global toggle
prefs.isEnabled = true

// Frequency
prefs.frequency = .important  // Only important notifications

// Categories
prefs.setCategoryEnabled("promotions", enabled: false)

// Topics
prefs.subscribe(to: "tech-news")
prefs.unsubscribe(from: "sports")

// Sound/Vibration
prefs.soundEnabled = true
prefs.vibrationEnabled = false

// Preview mode
prefs.previewMode = .whenUnlocked

🎯 Personalization

// Create personalization data
let data = PersonalizationData(userName: "John")
    .value("product", "iPhone 15")
    .value("discount", "20%")

// Use in notification
Notification(id: "personal-offer")
    .title("Hey {{name}}! 👋")
    .body("Get {{discount}} off on {{product}}")
    .personalize(data)

// Result: "Hey John! 👋" / "Get 20% off on iPhone 15"

📍 Location-Based Notifications

#if canImport(CoreLocation)
import CoreLocation

// Request authorization
LocationNotificationManager.shared.requestAuthorization(always: true)

// Register geofence
let notification = Notification(id: "store-nearby")
    .title("You're near our store!")
    .body("Stop by for exclusive in-store deals")

let geofence = GeofenceNotification(
    identifier: "store-123",
    latitude: 37.7749,
    longitude: -122.4194,
    radius: 200,
    notification: notification
)
.onEntry(true)
.onExit(false)
.name("Downtown Store")

try LocationNotificationManager.shared.register(geofence)
#endif

📅 Smart Scheduling

let scheduler = NotificationScheduler()

// Optimal delivery
try await scheduler.scheduleOptimally(
    notification,
    within: .next(hours: 24)
)

// Recurring notifications
let ids = try await scheduler.scheduleRecurring(
    notification,
    pattern: .daily(hour: 9, minute: 0),
    count: 7  // Next 7 days
)

// Snooze
try await scheduler.snooze(
    notificationId: "reminder-1",
    for: .minutes(15)
)

// Batch scheduling
let batchId = try await scheduler.scheduleBatch([
    notification1,
    notification2,
    notification3
])

📈 Delivery Optimization

let optimizer = DeliveryOptimizer()

// Get optimal delivery time
let optimalHour = optimizer.optimalHour()
let optimalDay = optimizer.optimalDayOfWeek()
let nextOptimal = optimizer.nextOptimalDeliveryDate()

// Get engagement heatmap
let heatmap = optimizer.engagementHeatmap()
// [0: 0.1, 1: 0.05, ..., 9: 0.8, 10: 0.85, ...]

// Get recommendations
let recommendations = optimizer.getRecommendations()
// ["Best delivery time is around 10:00", "Avoid sending at: 2:00, 3:00, 4:00"]

📖 API Reference

NotificationKit

Method	Description
`configure(_:)`	Configure global settings
`requestAuthorization()`	Request notification permissions
`requestProvisionalAuthorization()`	Request quiet notifications
`schedule(builder:)`	Schedule using builder pattern
`schedule(_:)`	Schedule notification directly
`cancel(identifier:)`	Cancel by ID
`cancelAll()`	Cancel all pending
`pendingNotifications()`	Get pending requests
`deliveredNotifications()`	Get delivered notifications
`register(category:)`	Register interactive category
`setBadge(_:)`	Set badge number
`clearBadge()`	Clear badge
`registerForRemoteNotifications()`	Register for push

Notification Builder

Method	Description
`.title(_:)`	Set title
`.subtitle(_:)`	Set subtitle
`.body(_:)`	Set body text
`.sound(_:)`	Set sound
`.badge(_:)`	Set badge number
`.category(_:)`	Set category ID
`.thread(_:)`	Set thread ID
`.trigger(_:)`	Set trigger
`.image(_:)`	Add image attachment
`.video(_:)`	Add video attachment
`.timeSensitive()`	Mark time sensitive
`.critical()`	Mark critical
`.relevanceScore(_:)`	Set relevance (0-1)
`.channel(_:)`	Set channel ID
`.abTest(_:)`	Set A/B test ID
`.deepLink(_:)`	Set deep link URL
`.personalize(_:)`	Apply personalization
`.bypassQuietHours()`	Bypass quiet hours
`.bypassRateLimit()`	Bypass rate limiting
`.priority(_:)`	Set priority level
`.expires(at:)`	Set expiration date

📁 Project Structure

iOS-Notification-Framework/
├── Sources/
│   └── NotificationKit/
│       ├── NotificationKit.swift           # Main API
│       ├── Core/
│       │   ├── NotificationConfiguration.swift
│       │   ├── NotificationAnalytics.swift
│       │   ├── NotificationScheduler.swift
│       │   ├── DeliveryOptimizer.swift
│       │   ├── RateLimiter.swift
│       │   ├── QuietHoursManager.swift
│       │   ├── ChannelManager.swift
│       │   ├── ABTestingEngine.swift
│       │   ├── DeepLinkHandler.swift
│       │   └── UserPreferenceManager.swift
│       ├── Models/
│       │   ├── Notification.swift
│       │   ├── NotificationTrigger.swift
│       │   └── NotificationCategory.swift
│       └── Extensions/
│           ├── RichNotificationSupport.swift
│           └── LocationNotificationManager.swift
├── Tests/
│   └── NotificationKitTests/
├── Documentation/
└── Package.swift

🧪 Testing

swift test

Run with verbose output:

swift test --verbose

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md first.

Fork the repository
Create feature branch (git checkout -b feature/amazing)
Commit changes (git commit -m 'feat: add amazing feature')
Push (git push origin feature/amazing)
Open Pull Request

📄 License

MIT License - see LICENSE for details.

⬆ Back to Top

Made with ❤️ for the iOS community

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
.github		.github
Documentation		Documentation
Examples		Examples
Sources/NotificationKit		Sources/NotificationKit
Tests/NotificationKitTests		Tests/NotificationKitTests
.editorconfig		.editorconfig
.gitignore		.gitignore
.swiftlint.yml		.swiftlint.yml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
Package.swift		Package.swift
README.md		README.md
SECURITY.md		SECURITY.md
iOSNotificationFramework.podspec		iOSNotificationFramework.podspec

Uh oh!

License

muhittincamdali/iOS-Notification-Framework

Folders and files

Latest commit

History

Repository files navigation

🏆 Why NotificationKit?

📋 Table of Contents

✨ Features

🔔 Core Notifications

📊 Analytics & Optimization

🎛️ Advanced Controls

🔗 Integration

🚀 Quick Start

1. Configure on App Launch

2. Request Permission

3. Schedule a Notification

📦 Installation

Swift Package Manager

Requirements

🎯 Core Concepts

Notification Builder

Trigger Types

Rich Notifications

Interactive Categories

🚀 Advanced Features

📊 Analytics

🧪 A/B Testing

🌙 Quiet Hours

📈 Rate Limiting

📺 Notification Channels

🔗 Deep Linking

👤 User Preferences

🎯 Personalization

📍 Location-Based Notifications

📅 Smart Scheduling

📈 Delivery Optimization

📖 API Reference

NotificationKit

Notification Builder

📁 Project Structure

🧪 Testing

🤝 Contributing

📄 License

About

Topics

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 1

Sponsor this project

Uh oh!

Packages 0

Contributors 2

Uh oh!

Languages

Packages