KMPNotifier

Initialize the library once in your Application.onCreate().

Requirements:

• minSdkVersion 23
• For Android 13 (API 33+), you must manually request the POST_NOTIFICATIONS runtime permission in an Activity.

Configuration Options:

• notificationIconResId: Resource ID for the notification icon.
• showPushNotification: If false, foreground push notifications will not be shown to the user (though content can still be accessed via PushListener).
• notificationChannelData: Optional customization for the notification channel.

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        KMPNotifier.initialize(
            configuration = NotificationPlatformConfiguration.Android(
                notificationIconResId = R.drawable.ic_launcher_foreground,
                showPushNotification = true,
                notificationChannelData = NotificationPlatformConfiguration.Android.NotificationChannelData(),
            ),
            FirebasePush, // Use LocalNotifications if you don't want push
        )
    }
}

For push notifications, follow these steps in Xcode:

1. Add firebase-ios-sdk via Swift Package Manager (specifically the FirebaseMessaging product, version 12.14.0 exact).
2. Add Push Notifications and Background Modes (Remote Notifications) capabilities.
3. Call FirebaseApp.configure().
4. Set the apnsToken in didRegisterForRemoteNotificationsWithDeviceToken.

Important: KMPNotifier.shared.initialize must be called from the main thread to ensure the notification delegate is installed correctly for cold-start clicks.

Configuration Options:

• showPushNotification: Enables/disables push UI.
• askNotificationPermissionOnStart: Automatically prompts for permission.
• notificationSoundName: Optional custom sound bundle name.

import SwiftUI
import shared
import FirebaseCore
import FirebaseMessaging

class AppDelegate: NSObject, UIApplicationDelegate {

  func application(_ application: UIApplication,
                   didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {

      FirebaseApp.configure() // Required

      KMPNotifier.shared.initialize(
          configuration: NotificationPlatformConfigurationIos(
              showPushNotification: true,
              askNotificationPermissionOnStart: true,
              notificationSoundName: nil
          ),
          extensions: [FirebasePush.shared]
      )

    return true
  }

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
        Messaging.messaging().apnsToken = deviceToken
  }
    
}

@main
struct iOSApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

KMPNotifier 2.0 is modularized. Instead of a single umbrella dependency, you can now pick specific modules based on your needs.

Requirements: Your project must use Kotlin 2.4.0+ to consume 2.0.0 artifacts.

Available Modules:

• kmpnotifier-core: Configuration, permissions, logging, and shared events.
• kmpnotifier-local: Local notifications (depends on core).
• kmpnotifier-push-firebase: Firebase Cloud Messaging push (depends on local; provides a no-op mock on desktop/web).
• kmpnotifier: The deprecated umbrella module that pulls in all the above (behaves like 1.x).

Handling Duplicate Class Errors: If a transitive dependency pulls in kmpnotifier:1.x while you are using the new modules, Android builds will fail due to duplicate classes. You must force-upgrade or exclude the old artifact: implementation("...") { exclude(group = "io.github.mirzemehdi", module = "kmpnotifier") }

commonMain.dependencies {
    // Local notifications only — no Firebase anywhere:
    api("io.github.mirzemehdi:kmpnotifier-local:2.0.0")

    // Push: add the push module too:
    api("io.github.mirzemehdi:kmpnotifier-push-firebase:2.0.0")
}

1. Add mavenCentral() to your root build.gradle.kts or settings.gradle.
2. Add the desired module to your shared module's commonMain dependencies. Use api to ensure visibility in the iOS framework.
3. If using push notifications, apply the com.google.gms.google-services plugin in your androidApp/build.gradle.kts.
4. For iOS, export the modules in your framework configuration to make them accessible to Swift.

// 1. Repositories
repositories {
  mavenCentral()
}

// 2. Shared Module Dependencies
sourceSets {
  commonMain.dependencies {
    // For local notifications only:
    api("io.github.mirzemehdi:kmpnotifier-local:<version>")
    
    // For Firebase push (includes local):
    api("io.github.mirzemehdi:kmpnotifier-push-firebase:<version>")
  }
}

// 3. iOS Framework Export
listOf(iosX64(), iosArm64(), iosSimulatorArm64()).forEach {
  it.binaries.framework {
    export("io.github.mirzemehdi:kmpnotifier-core:<version>")
    export("io.github.mirzemehdi:kmpnotifier-local:<version>")
    export("io.github.mirzemehdi:kmpnotifier-push-firebase:<version>")
  }
}

Push notifications are supported on Android and iOS via the kmpnotifier-push-firebase module. On desktop and web, this module acts as a no-op mock.

1. Listen for Push Events

Register a PushListener using KMPNotifier.addPushListener to handle token updates and incoming messages. Available callbacks include onNewToken, onPushNotification, onPayloadData, and onPushNotificationWithPayloadData.

2. Platform Integration (Required)

You must call platform-specific hooks to ensure payloads are delivered correctly:

• Android: Call KMPNotifier.onCreateOrOnNewIntent(intent) in your Activity's onCreate and onNewIntent.
• iOS: Call KMPNotifier.onApplicationDidReceiveRemoteNotification(userInfo:) in your app's didReceiveRemoteNotification method.

3. Token and Topic Management

All push notifier methods are suspend functions and must be called from a coroutine:

• getToken(): Retrieves the current push token.
• deleteMyToken(): Deletes the current token (e.g., on logout).
• subscribeToTopic(topic): Subscribes to a Firebase topic.
• unSubscribeFromTopic(topic): Unsubscribes from a Firebase topic.

// Listening for push events
KMPNotifier.addPushListener(object : PushListener {
  override fun onNewToken(token: String) {
    println("onNewToken: $token")
  }

  override fun onPushNotification(title: String?, body: String?) {
    println("Push received — title: $title, body: $body")
  }
})

// Token management (inside a coroutine)
val token = KMPNotifier.firebasePushNotifier.getToken()
KMPNotifier.firebasePushNotifier.subscribeToTopic("new_users")