@onesignal/capacitor-plugin 1.0.3 → 1.0.4

package/README.md

@@ -24,13 +24,13 @@ See the `examples/demo` directory for a full working example.
 
 <docgen-index>
 
-- [`initialize(...)`](#initialize)
-- [`login(...)`](#login)
-- [`logout()`](#logout)
-- [`setConsentRequired(...)`](#setconsentrequired)
-- [`setConsentGiven(...)`](#setconsentgiven)
-- [Interfaces](#interfaces)
-- [Type Aliases](#type-aliases)
+* [`initialize(...)`](#initialize)
+* [`login(...)`](#login)
+* [`logout()`](#logout)
+* [`setConsentRequired(...)`](#setconsentrequired)
+* [`setConsentGiven(...)`](#setconsentgiven)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 
 </docgen-index>
 
@@ -51,7 +51,8 @@ Initialize the SDK with your OneSignal app ID. Call during app startup.
 | ----------- | ------------------- |
 | **`appId`** | <code>string</code> |
 
----
+--------------------
+
 
 ### login(...)
 
@@ -65,7 +66,8 @@ Log in to OneSignal as the user identified by `externalId`, switching the user c
 | ---------------- | ------------------- |
 | **`externalId`** | <code>string</code> |
 
----
+--------------------
+
 
 ### logout()
 
@@ -75,7 +77,8 @@ logout() => Promise<void>
 
 Log out the current user. The SDK will reference a new device-scoped user.
 
----
+--------------------
+
 
 ### setConsentRequired(...)
 
@@ -89,7 +92,8 @@ Set whether user privacy consent is required before sending data to OneSignal. C
 | -------------- | -------------------- |
 | **`required`** | <code>boolean</code> |
 
----
+--------------------
+
 
 ### setConsentGiven(...)
 
@@ -103,10 +107,12 @@ Indicate whether the user has granted privacy consent.
 | ------------- | -------------------- |
 | **`granted`** | <code>boolean</code> |
 
----
+--------------------
+
 
 ### Interfaces
 
+
 #### OneSignalDebugAPI
 
 Debug helpers exposed via `OneSignal.Debug`.
@@ -116,6 +122,7 @@ Debug helpers exposed via `OneSignal.Debug`.
 | **setLogLevel**   | (logLevel: <a href="#loglevel">LogLevel</a>) =&gt; void       | Set the log level printed to LogCat (Android) or the Xcode console (iOS). |
 | **setAlertLevel** | (visualLogLevel: <a href="#loglevel">LogLevel</a>) =&gt; void | Set the log level shown to the user as alert dialogs.                     |
 
+
 #### OneSignalUserAPI
 
 Current-user operations exposed via `OneSignal.User`.
@@ -146,12 +153,14 @@ Current-user operations exposed via `OneSignal.User`.
 | **getExternalId**       | () =&gt; Promise&lt;string \| null&gt;                                                                       | Get the external ID set via `login`, or null if the user is anonymous.                    |
 | **trackEvent**          | (name: string, properties?: object \| undefined) =&gt; Promise&lt;void&gt;                                   | Track a custom event with an optional set of JSON-serializable properties.                |
 
+
 #### UserChangedState
 
 | Prop          | Type                                            |
 | ------------- | ----------------------------------------------- |
 | **`current`** | <code><a href="#userstate">UserState</a></code> |
 
+
 #### UserState
 
 | Prop              | Type                |
@@ -159,6 +168,7 @@ Current-user operations exposed via `OneSignal.User`.
 | **`onesignalId`** | <code>string</code> |
 | **`externalId`**  | <code>string</code> |
 
+
 #### OneSignalPushSubscriptionAPI
 
 Push subscription state and controls exposed via `OneSignal.User.pushSubscription`.
@@ -173,6 +183,7 @@ Push subscription state and controls exposed via `OneSignal.User.pushSubscriptio
 | **optIn**               | () =&gt; Promise&lt;void&gt;                                                                                                         | Opt the user in to push notifications. Prompts for permission if needed.                                                                                                                            |
 | **optOut**              | () =&gt; Promise&lt;void&gt;                                                                                                         | Opt the user out of push notifications on this device.                                                                                                                                              |
 
+
 #### PushSubscriptionChangedState
 
 | Prop           | Type                                                                    |
@@ -180,6 +191,7 @@ Push subscription state and controls exposed via `OneSignal.User.pushSubscriptio
 | **`previous`** | <code><a href="#pushsubscriptionstate">PushSubscriptionState</a></code> |
 | **`current`**  | <code><a href="#pushsubscriptionstate">PushSubscriptionState</a></code> |
 
+
 #### PushSubscriptionState
 
 | Prop          | Type                 |
@@ -188,6 +200,7 @@ Push subscription state and controls exposed via `OneSignal.User.pushSubscriptio
 | **`token`**   | <code>string</code>  |
 | **`optedIn`** | <code>boolean</code> |
 
+
 #### OneSignalNotificationsAPI
 
 Notification permission and event handling exposed via `OneSignal.Notifications`.
@@ -205,6 +218,7 @@ Notification permission and event handling exposed via `OneSignal.Notifications`
 | **removeNotification**                  | (id: number) =&gt; Promise&lt;void&gt;                                                                                                                       | Android only. Cancel a single notification by its Android notification ID.               |
 | **removeGroupedNotifications**          | (id: string) =&gt; Promise&lt;void&gt;                                                                                                                       | Android only. Cancel a group of notifications by group key.                              |
 
+
 #### NotificationClickEvent
 
 | Prop               | Type                                                                        |
@@ -212,6 +226,7 @@ Notification permission and event handling exposed via `OneSignal.Notifications`
 | **`result`**       | <code><a href="#notificationclickresult">NotificationClickResult</a></code> |
 | **`notification`** | <code>OSNotification</code>                                                 |
 
+
 #### NotificationClickResult
 
 | Prop           | Type                |
@@ -219,6 +234,7 @@ Notification permission and event handling exposed via `OneSignal.Notifications`
 | **`actionId`** | <code>string</code> |
 | **`url`**      | <code>string</code> |
 
+
 #### OneSignalInAppMessagesAPI
 
 In-app message triggers and event handling exposed via `OneSignal.InAppMessages`.
@@ -235,6 +251,7 @@ In-app message triggers and event handling exposed via `OneSignal.InAppMessages`
 | **setPaused**           | (pause: boolean) =&gt; void                                                                                                                                  | Pause or resume the display of in-app messages.                                                     |
 | **getPaused**           | () =&gt; Promise&lt;boolean&gt;                                                                                                                              | Whether in-app messaging is currently paused.                                                       |
 
+
 #### InAppMessageClickEvent
 
 | Prop          | Type                                                                        |
@@ -242,12 +259,14 @@ In-app message triggers and event handling exposed via `OneSignal.InAppMessages`
 | **`message`** | <code><a href="#osinappmessage">OSInAppMessage</a></code>                   |
 | **`result`**  | <code><a href="#inappmessageclickresult">InAppMessageClickResult</a></code> |
 
+
 #### OSInAppMessage
 
 | Prop            | Type                |
 | --------------- | ------------------- |
 | **`messageId`** | <code>string</code> |
 
+
 #### InAppMessageClickResult
 
 | Prop                 | Type                                                                            |
@@ -257,30 +276,35 @@ In-app message triggers and event handling exposed via `OneSignal.InAppMessages`
 | **`url`**            | <code>string</code>                                                             |
 | **`urlTarget`**      | <code><a href="#inappmessageactionurltype">InAppMessageActionUrlType</a></code> |
 
+
 #### InAppMessageWillDisplayEvent
 
 | Prop          | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`message`** | <code><a href="#osinappmessage">OSInAppMessage</a></code> |
 
+
 #### InAppMessageDidDisplayEvent
 
 | Prop          | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`message`** | <code><a href="#osinappmessage">OSInAppMessage</a></code> |
 
+
 #### InAppMessageWillDismissEvent
 
 | Prop          | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`message`** | <code><a href="#osinappmessage">OSInAppMessage</a></code> |
 
+
 #### InAppMessageDidDismissEvent
 
 | Prop          | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`message`** | <code><a href="#osinappmessage">OSInAppMessage</a></code> |
 
+
 #### OneSignalSessionAPI
 
 Outcome reporting exposed via `OneSignal.Session`.
@@ -291,6 +315,7 @@ Outcome reporting exposed via `OneSignal.Session`.
 | **addUniqueOutcome**    | (name: string) =&gt; Promise&lt;void&gt;                | <a href="#record">Record</a> a unique outcome with the given name against the current session.     |
 | **addOutcomeWithValue** | (name: string, value: number) =&gt; Promise&lt;void&gt; | <a href="#record">Record</a> an outcome with the given name and value against the current session. |
 
+
 #### OneSignalLocationAPI
 
 Location permission and sharing exposed via `OneSignal.Location`.
@@ -301,6 +326,7 @@ Location permission and sharing exposed via `OneSignal.Location`.
 | **setShared**         | (shared: boolean) =&gt; void    | Enable or disable sharing the device location with OneSignal.   |
 | **isShared**          | () =&gt; Promise&lt;boolean&gt; | Whether the device location is currently shared with OneSignal. |
 
+
 #### OneSignalLiveActivitiesAPI
 
 Live activity controls exposed via `OneSignal.LiveActivities`. iOS only unless noted.
@@ -314,48 +340,56 @@ Live activity controls exposed via `OneSignal.LiveActivities`. iOS only unless n
 | **setupDefault**           | (options?: <a href="#liveactivitysetupoptions">LiveActivitySetupOptions</a> \| undefined) =&gt; Promise&lt;void&gt;                                                           | Set up the OneSignal default live activity, optionally enabling pushToStart/pushToUpdate. |
 | **startDefault**           | (activityId: string, attributes: <a href="#record">Record</a>&lt;string, unknown&gt;, content: <a href="#record">Record</a>&lt;string, unknown&gt;) =&gt; Promise&lt;void&gt; | Start a live activity backed by the OneSignal default attributes type.                    |
 
+
 ### Type Aliases
 
+
 #### LogLevel
 
 <code>(typeof <a href="#loglevel">LogLevel</a>)[keyof typeof LogLevel]</code>
 
+
 #### Record
 
 Construct a type with a set of properties K of type T
 
-<code>{
-[P in K]: T;
-}</code>
+<code>{
 [P in K]: T;
 }</code>
+
 
 #### OSNotificationPermission
 
 <code>(typeof <a href="#osnotificationpermission">OSNotificationPermission</a>)[keyof typeof OSNotificationPermission]</code>
 
+
 #### NotificationEventName
 
 <code>'click' | 'foregroundWillDisplay' | 'permissionChange'</code>
 
+
 #### NotificationEventTypeMap
 
 <code>{ click: <a href="#notificationclickevent">NotificationClickEvent</a>; foregroundWillDisplay: NotificationWillDisplayEvent; permissionChange: boolean; }</code>
 
+
 #### InAppMessageEventName
 
 <code>'click' | 'willDisplay' | 'didDisplay' | 'willDismiss' | 'didDismiss'</code>
 
+
 #### InAppMessageEventTypeMap
 
 <code>{ click: <a href="#inappmessageclickevent">InAppMessageClickEvent</a>; willDisplay: <a href="#inappmessagewilldisplayevent">InAppMessageWillDisplayEvent</a>; didDisplay: <a href="#inappmessagediddisplayevent">InAppMessageDidDisplayEvent</a>; willDismiss: <a href="#inappmessagewilldismissevent">InAppMessageWillDismissEvent</a>; didDismiss: <a href="#inappmessagediddismissevent">InAppMessageDidDismissEvent</a>; }</code>
 
+
 #### InAppMessageActionUrlType
 
 <code>'browser' | 'webview' | 'replacement'</code>
 
+
 #### LiveActivitySetupOptions
 
 The setup options for `OneSignal.LiveActivities.setupDefault`.
 
-<code>{ /** _ When true, OneSignal will listen for pushToStart tokens for the `OneSignalLiveActivityAttributes` structure. _/ enablePushToStart: boolean; /** _ When true, OneSignal will listen for pushToUpdate tokens for each start live activity that uses the _ `OneSignalLiveActivityAttributes` structure. \*/ enablePushToUpdate: boolean; }</code>
+<code>{ /** * When true, OneSignal will listen for pushToStart tokens for the `OneSignalLiveActivityAttributes` structure. */ enablePushToStart: boolean; /** * When true, OneSignal will listen for pushToUpdate tokens for each start live activity that uses the * `OneSignalLiveActivityAttributes` structure. */ enablePushToUpdate: boolean; }</code>
 
 </docgen-api>

package/android/build.gradle.kts

@@ -24,11 +24,23 @@ buildscript {
         return result ?: error("Version '$key' not found in ${catalogFile.name}")
     }
 
-    val kotlinVersion: String = if (project.hasProperty("kotlin_version")) {
-        rootProject.extra["kotlin_version"] as String
-    } else {
-        fromCatalog("kotlin")
-    }
+    // Both AGP and Kotlin Gradle Plugin are classpathed here so the plugin
+    // builds inside Capacitor 7 hosts, whose root build.gradle does not
+    // provide either for sub-projects. Capacitor 8 hosts that already pin
+    // their own kotlin_version can override via rootProject.ext.kotlin_version.
+    //
+    // The catalog default matches the Capacitor 8 upgrade guide's
+    // recommended kotlin_version (2.2.20). That matters because the host
+    // classpath can resolve kotlin-stdlib to 2.x; the 1.9 compiler can't
+    // read 2.x metadata, which is exactly what broke 1.0.2 on Capacitor 8
+    // (issue #18). A 2.2.x compiler reads both 1.x and 2.x stdlib bytecode,
+    // so the plugin works under Cap 7 and Cap 8.
+    // findProperty matches hasProperty's broad source set (extras, gradle.properties,
+    // -P flags, ORG_GRADLE_PROJECT_* env vars). Reading rootProject.extra directly
+    // would only see ext { ... } values and crash on the others with
+    // UnknownPropertyException, so prefer findProperty + toString().
+    val kotlinVersion: String =
+        project.findProperty("kotlin_version")?.toString() ?: fromCatalog("kotlin")
     val androidGradlePluginVersion: String = fromCatalog("androidGradlePlugin")
 
     repositories {
@@ -63,19 +75,14 @@ fun catalogVersion(key: String): String {
     return result ?: error("Version '$key' not found in ${toml.name}")
 }
 
+// See the kotlin_version note in buildscript {}: findProperty honors every property
+// source hasProperty does (extras, gradle.properties, -P, env), and toString()
+// avoids the String/Int cast hazard since gradle.properties values are always String.
 fun propertyOrCatalog(propertyName: String, catalogKey: String): String =
-    if (project.hasProperty(propertyName)) {
-        rootProject.extra[propertyName] as String
-    } else {
-        catalogVersion(catalogKey)
-    }
+    project.findProperty(propertyName)?.toString() ?: catalogVersion(catalogKey)
 
 fun intPropertyOrCatalog(propertyName: String, catalogKey: String): Int =
-    if (project.hasProperty(propertyName)) {
-        rootProject.extra[propertyName] as Int
-    } else {
-        catalogVersion(catalogKey).toInt()
-    }
+    project.findProperty(propertyName)?.toString()?.toInt() ?: catalogVersion(catalogKey).toInt()
 
 val junitVersion: String = propertyOrCatalog("junitVersion", "junit")
 val androidxAppCompatVersion: String = propertyOrCatalog("androidxAppCompatVersion", "androidxAppCompat")
@@ -108,7 +115,7 @@ configure<com.android.build.gradle.LibraryExtension> {
 }
 
 tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
-    kotlinOptions.jvmTarget = "17"
+    compilerOptions.jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_17)
 }
 
 repositories {

package/android/gradle/libs.versions.toml

@@ -1,21 +1,32 @@
 # Version catalog for the OneSignal Capacitor Android plugin.
-# Defaults below can be overridden by the consuming app via gradle
-# properties or rootProject.extra (see android/build.gradle.kts).
 #
-# compileSdk / minSdk / targetSdk / kotlin / appcompat / junit follow
-# Capacitor 7's required versions, not the OneSignal Android SDK's.
+# Host apps can override most defaults by setting the matching
+# rootProject.ext.<key> values; see android/build.gradle.kts for the
+# property-or-catalog lookup logic.
+#
+# kotlin: matches Capacitor 8's recommended kotlin_version (2.2.20, per
+#   Capacitor 8 upgrade docs). A 2.2.x compiler reads kotlin-stdlib bytecode
+#   from 1.x and 2.x without metadata version errors, which is what makes a
+#   single artifact compile under both Capacitor 7 hosts (Kotlin 1.9.x
+#   stdlib) and Capacitor 8 hosts (Kotlin 2.2.x stdlib).
+# androidGradlePlugin: kept at 8.7.3. Cap 8 recommends 8.13.0, but bumping
+#   here would force Gradle 8.13+ in standalone plugin builds, which a
+#   freshly scaffolded Cap 7 project (Gradle 8.11.1) cannot supply. In host
+#   builds the host's AGP wins regardless.
+# SDK levels / library versions: bumped to Capacitor 8's recommended floors
+#   for documentation parity. Host apps still override via rootProject.ext.
 
 [versions]
 androidGradlePlugin = "8.7.3"
-androidxAppCompat = "1.7.0"
-androidxEspresso = "3.6.1"
-androidxTestJunit = "1.2.1"
-compileSdk = "35"
+androidxAppCompat = "1.7.1"
+androidxEspresso = "3.7.0"
+androidxTestJunit = "1.3.0"
+compileSdk = "36"
 junit = "4.13.2"
-kotlin = "1.9.25"
-minSdk = "23"
+kotlin = "2.2.20"
+minSdk = "24"
 onesignal = "5.9.1"
-targetSdk = "35"
+targetSdk = "36"
 
 [libraries]
 androidx-appcompat = { module = "androidx.appcompat:appcompat", version.ref = "androidxAppCompat" }

package/android/src/main/kotlin/com/onesignal/capacitor/OneSignalCapacitorPlugin.kt

@@ -134,7 +134,7 @@ class OneSignalCapacitorPlugin : Plugin(),
         initialized = true
 
         OneSignalWrapper.sdkType = "capacitor"
-        OneSignalWrapper.sdkVersion = "010003"
+        OneSignalWrapper.sdkVersion = "010004"
         OneSignal.initWithContext(context, appId)
 
         // If the SDK was initialized from a non-Activity context (FCM/work
@@ -718,6 +718,11 @@ class OneSignalCapacitorPlugin : Plugin(),
     // region Observer Callbacks
 
     override fun onWillDisplay(event: INotificationWillDisplayEvent) {
+        // Match Cordova's default-display behavior: if no JS listener has
+        // subscribed via Notifications.addEventListener('foregroundWillDisplay'),
+        // leave the event untouched so the OneSignal native SDK falls back to
+        // its default behavior and displays the notification automatically.
+        if (!hasListeners("notificationForegroundWillDisplay")) return
         // No retainUntilConsumed needed: foreground will-display only fires
         // while the app is foregrounded, so the JS layer's listener is
         // already attached. Contrast with onClick() below, which can fire

package/dist/index.d.ts

@@ -95,6 +95,7 @@ declare class Notifications implements OneSignalNotificationsAPI {
   private _hasRegisteredClickListener;
   private _hasRegisteredForegroundWillDisplayListener;
   private _hasRegisteredPermissionListener;
+  private _foregroundWillDisplayListenerHandle?;
   constructor(plugin: OneSignalCapacitorPlugin);
   private _processFunctionList;
   /**

package/dist/index.js

@@ -471,7 +471,7 @@ var Notifications = class {
 			this._notificationWillDisplayListeners.push(listener);
 			if (!this._hasRegisteredForegroundWillDisplayListener) {
 				this._hasRegisteredForegroundWillDisplayListener = true;
-				this._plugin.addListener("notificationForegroundWillDisplay", (notification) => {
+				this._foregroundWillDisplayListenerHandle = this._plugin.addListener("notificationForegroundWillDisplay", (notification) => {
 					this._notificationWillDisplayListeners.forEach((listener) => {
 						listener(new NotificationWillDisplayEvent(notification));
 					});
@@ -496,8 +496,15 @@ var Notifications = class {
 	*/
 	removeEventListener(event, listener) {
 		if (event === "click") removeListener(this._notificationClickedListeners, listener);
-		else if (event === "foregroundWillDisplay") removeListener(this._notificationWillDisplayListeners, listener);
-		else if (event === "permissionChange") removeListener(this._permissionObserverList, listener);
+		else if (event === "foregroundWillDisplay") {
+			removeListener(this._notificationWillDisplayListeners, listener);
+			if (this._notificationWillDisplayListeners.length === 0) {
+				this._hasRegisteredForegroundWillDisplayListener = false;
+				const listenerHandle = this._foregroundWillDisplayListenerHandle;
+				this._foregroundWillDisplayListenerHandle = void 0;
+				listenerHandle?.then((handle) => handle.remove());
+			}
+		} else if (event === "permissionChange") removeListener(this._permissionObserverList, listener);
 	}
 	/**
 	* Removes all OneSignal notifications.

package/ios/Sources/OneSignalCapacitorPlugin/OneSignalCapacitorPlugin.swift

@@ -110,7 +110,7 @@ public class OneSignalCapacitorPlugin: CAPPlugin, CAPBridgedPlugin {
         initialized = true
 
         OneSignalWrapper.sdkType = "capacitor"
-        OneSignalWrapper.sdkVersion = "010003"
+        OneSignalWrapper.sdkVersion = "010004"
         // OSCapacitorLaunchOptions's +load captures the dictionary from
         // UIApplicationDidFinishLaunchingNotification at process start (before
         // main()), so cold-start notification taps that arrive via launchOptions
@@ -616,6 +616,11 @@ public class OneSignalCapacitorPlugin: CAPPlugin, CAPBridgedPlugin {
     }
 
     public func onWillDisplay(event: OSNotificationWillDisplayEvent) {
+        // Match Cordova's default-display behavior: if no JS listener has
+        // subscribed via Notifications.addEventListener('foregroundWillDisplay'),
+        // leave the event untouched so the OneSignal native SDK falls back to
+        // its default behavior and displays the notification automatically.
+        guard hasListeners("notificationForegroundWillDisplay") else { return }
         guard let notificationId = event.notification.notificationId else { return }
         notificationWillDisplayCache[notificationId] = event
         event.preventDefault()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onesignal/capacitor-plugin",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "OneSignal is a high volume Push Notification service for mobile apps. This is the pure Capacitor plugin for OneSignal, providing push notifications, in-app messaging, and more.",
   "keywords": [
     "apns",