chore: Release 1.0.2 (#17)

fadi-george · github-actions[bot] · web-flow · commit e8fa8068b1f1 · 2026-05-08T13:16:47.000-07:00
Co-authored-by: github-actions[bot] &lt;noreply@onesignal.com&gt;
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -11,6 +11,7 @@ on:
 permissions:
   id-token: write # Required for OIDC
   contents: write
+  pull-requests: read # Required by transitively-called github-release.yml
 
 jobs:
   publish:
diff --git a/README.md b/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,19 +153,22 @@ 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                |
 | ----------------- | ------------------- |
 | **`onesignalId`** | <code>string</code> |
 | **`externalId`**  | <code>string</code> |
 
+
 #### OneSignalPushSubscriptionAPI
 
 Push subscription state and controls exposed via `OneSignal.User.pushSubscription`.
@@ -173,13 +183,15 @@ 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                                                                    |
 | -------------- | ----------------------------------------------------------------------- |
 | **`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,20 +218,23 @@ 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                                                                        |
 | ------------------ | --------------------------------------------------------------------------- |
 | **`result`**       | <code><a href="#notificationclickresult">NotificationClickResult</a></code> |
 | **`notification`** | <code>OSNotification</code>                                                 |
 
+
 #### NotificationClickResult
 
 | Prop           | Type                |
 | -------------- | ------------------- |
 | **`actionId`** | <code>string</code> |
 | **`url`**      | <code>string</code> |
 
+
 #### OneSignalInAppMessagesAPI
 
 In-app message triggers and event handling exposed via `OneSignal.InAppMessages`.
@@ -235,19 +251,22 @@ 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                                                                        |
 | ------------- | --------------------------------------------------------------------------- |
 | **`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>
diff --git a/android/src/main/kotlin/com/onesignal/capacitor/OneSignalCapacitorPlugin.kt b/android/src/main/kotlin/com/onesignal/capacitor/OneSignalCapacitorPlugin.kt
@@ -134,7 +134,7 @@ class OneSignalCapacitorPlugin : Plugin(),
         initialized = true
 
         OneSignalWrapper.sdkType = "capacitor"
-        OneSignalWrapper.sdkVersion = "010000"
+        OneSignalWrapper.sdkVersion = "010002"
         OneSignal.initWithContext(context, appId)
 
         // If the SDK was initialized from a non-Activity context (FCM/work
diff --git a/examples/demo/src/hooks/useOneSignal.ts b/examples/demo/src/hooks/useOneSignal.ts
@@ -7,6 +7,7 @@ import OneSignal, {
   type InAppMessageWillDisplayEvent,
   type NotificationClickEvent,
   type NotificationWillDisplayEvent,
+  type PushSubscriptionChangedState,
   type UserChangedState,
 } from '@onesignal/capacitor-plugin';
 import { useCallback, useEffect, useRef, useState } from 'react';
@@ -200,16 +201,18 @@ export function useOneSignal(): UseOneSignalReturn {
       e.getNotification().display();
     };
 
-    const pushSubHandler = async () => {
-      const [id, optedIn] = await Promise.all([
-        OneSignal.User.pushSubscription.getIdAsync(),
-        OneSignal.User.pushSubscription.getOptedInAsync(),
-      ]);
-      setPushSubscriptionId(id ?? undefined);
-      setIsPushEnabled(optedIn);
+    const pushSubHandler = (event: PushSubscriptionChangedState) => {
+      const { previous, current } = event;
+      const fmtToken = (t: string | undefined) => (t ? `${t.slice(0, 8)}…` : 'null');
+      console.log(
+        `Push subscription changed: id=${previous.id ?? 'null'} → ${current.id ?? 'null'}, optedIn=${previous.optedIn} → ${current.optedIn}, token=${fmtToken(previous.token)} → ${fmtToken(current.token)}`,
+      );
+      setPushSubscriptionId(current.id ?? undefined);
+      setIsPushEnabled(current.optedIn);
     };
 
     const permissionHandler = (granted: boolean) => {
+      console.log(`Permission changed: ${granted}`);
       setHasNotificationPermission(granted);
     };
 
@@ -224,6 +227,11 @@ export function useOneSignal(): UseOneSignalReturn {
     };
 
     const load = async () => {
+      // Uncomment if you want so you have time to see logs while trying to open
+      // safari web inspector. Not an issue for chrome web inspector.
+      // await new Promise((resolve) => setTimeout(resolve, 10_000));
+      // if (cancelled) return;
+
       const nextAppId = resolveAppId();
       const nextConsentRequired = preferences.getConsentRequired();
       const nextPrivacyConsentGiven = preferences.getConsentGiven();
diff --git a/examples/demo_pods/src/hooks/useOneSignal.ts b/examples/demo_pods/src/hooks/useOneSignal.ts
@@ -7,6 +7,7 @@ import OneSignal, {
   type InAppMessageWillDisplayEvent,
   type NotificationClickEvent,
   type NotificationWillDisplayEvent,
+  type PushSubscriptionChangedState,
   type UserChangedState,
 } from '@onesignal/capacitor-plugin';
 import { useCallback, useEffect, useRef, useState } from 'react';
@@ -200,13 +201,14 @@ export function useOneSignal(): UseOneSignalReturn {
       e.getNotification().display();
     };
 
-    const pushSubHandler = async () => {
-      const [id, optedIn] = await Promise.all([
-        OneSignal.User.pushSubscription.getIdAsync(),
-        OneSignal.User.pushSubscription.getOptedInAsync(),
-      ]);
-      setPushSubscriptionId(id ?? undefined);
-      setIsPushEnabled(optedIn);
+    const pushSubHandler = (event: PushSubscriptionChangedState) => {
+      const { previous, current } = event;
+      const fmtToken = (t: string | undefined) => (t ? `${t.slice(0, 8)}…` : 'null');
+      console.log(
+        `Push subscription changed: id=${previous.id ?? 'null'} → ${current.id ?? 'null'}, optedIn=${previous.optedIn} → ${current.optedIn}, token=${fmtToken(previous.token)} → ${fmtToken(current.token)}`,
+      );
+      setPushSubscriptionId(current.id ?? undefined);
+      setIsPushEnabled(current.optedIn);
     };
 
     const permissionHandler = (granted: boolean) => {
@@ -224,6 +226,11 @@ export function useOneSignal(): UseOneSignalReturn {
     };
 
     const load = async () => {
+      // Uncomment if you want so you have time to see logs while trying to open
+      // safari web inspector. Not an issue for chrome web inspector.
+      // await new Promise((resolve) => setTimeout(resolve, 10_000));
+      // if (cancelled) return;
+
       const nextAppId = resolveAppId();
       const nextConsentRequired = preferences.getConsentRequired();
       const nextPrivacyConsentGiven = preferences.getConsentGiven();
diff --git a/ios/Sources/OneSignalCapacitorPlugin/OneSignalCapacitorPlugin.swift b/ios/Sources/OneSignalCapacitorPlugin/OneSignalCapacitorPlugin.swift
diff --git a/package.json b/package.json
