@onesignal/capacitor-plugin 1.0.2 → 1.0.3

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,8 +51,7 @@ Initialize the SDK with your OneSignal app ID. Call during app startup.
 | ----------- | ------------------- |
 | **`appId`** | <code>string</code> |
 
---------------------
-
+---
 
 ### login(...)
 
@@ -66,8 +65,7 @@ Log in to OneSignal as the user identified by `externalId`, switching the user c
 | ---------------- | ------------------- |
 | **`externalId`** | <code>string</code> |
 
---------------------
-
+---
 
 ### logout()
 
@@ -77,8 +75,7 @@ logout() => Promise<void>
 
 Log out the current user. The SDK will reference a new device-scoped user.
 
---------------------
-
+---
 
 ### setConsentRequired(...)
 
@@ -92,8 +89,7 @@ Set whether user privacy consent is required before sending data to OneSignal. C
 | -------------- | -------------------- |
 | **`required`** | <code>boolean</code> |
 
---------------------
-
+---
 
 ### setConsentGiven(...)
 
@@ -107,12 +103,10 @@ Indicate whether the user has granted privacy consent.
 | ------------- | -------------------- |
 | **`granted`** | <code>boolean</code> |
 
---------------------
-
+---
 
 ### Interfaces
 
-
 #### OneSignalDebugAPI
 
 Debug helpers exposed via `OneSignal.Debug`.
@@ -122,7 +116,6 @@ 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`.
@@ -153,14 +146,12 @@ 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                |
@@ -168,7 +159,6 @@ 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`.
@@ -183,7 +173,6 @@ 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                                                                    |
@@ -191,7 +180,6 @@ 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                 |
@@ -200,7 +188,6 @@ 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`.
@@ -218,7 +205,6 @@ 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                                                                        |
@@ -226,7 +212,6 @@ Notification permission and event handling exposed via `OneSignal.Notifications`
 | **`result`**       | <code><a href="#notificationclickresult">NotificationClickResult</a></code> |
 | **`notification`** | <code>OSNotification</code>                                                 |
 
-
 #### NotificationClickResult
 
 | Prop           | Type                |
@@ -234,7 +219,6 @@ 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`.
@@ -251,7 +235,6 @@ 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                                                                        |
@@ -259,14 +242,12 @@ 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                                                                            |
@@ -276,35 +257,30 @@ 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`.
@@ -315,7 +291,6 @@ 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`.
@@ -326,7 +301,6 @@ 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.
@@ -340,56 +314,48 @@ 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/gradle/libs.versions.toml

@@ -14,7 +14,7 @@ compileSdk = "35"
 junit = "4.13.2"
 kotlin = "1.9.25"
 minSdk = "23"
-onesignal = "5.8.1"
+onesignal = "5.9.1"
 targetSdk = "35"
 
 [libraries]

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

@@ -134,7 +134,7 @@ class OneSignalCapacitorPlugin : Plugin(),
         initialized = true
 
         OneSignalWrapper.sdkType = "capacitor"
-        OneSignalWrapper.sdkVersion = "010002"
+        OneSignalWrapper.sdkVersion = "010003"
         OneSignal.initWithContext(context, appId)
 
         // If the SDK was initialized from a non-Activity context (FCM/work

package/ios/Sources/OneSignalCapacitorPlugin/OneSignalCapacitorPlugin.swift

@@ -110,7 +110,7 @@ public class OneSignalCapacitorPlugin: CAPPlugin, CAPBridgedPlugin {
         initialized = true
 
         OneSignalWrapper.sdkType = "capacitor"
-        OneSignalWrapper.sdkVersion = "010002"
+        OneSignalWrapper.sdkVersion = "010003"
         // OSCapacitorLaunchOptions's +load captures the dictionary from
         // UIApplicationDidFinishLaunchingNotification at process start (before
         // main()), so cold-start notification taps that arrive via launchOptions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onesignal/capacitor-plugin",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "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",
@@ -62,15 +62,14 @@
     "@vitest/coverage-v8": "^4.1.2",
     "happy-dom": "^20.9.0",
     "typescript": "^5.9.3",
-    "vite": "npm:@voidzero-dev/vite-plus-core@latest",
     "vite-plus": "0.1.20"
   },
   "peerDependencies": {
     "@capacitor/core": ">=7.0.0"
   },
   "overrides": {
-    "vite": "npm:@voidzero-dev/vite-plus-core@latest",
-    "vitest": "npm:@voidzero-dev/vite-plus-test@latest"
+    "vite": "npm:@voidzero-dev/vite-plus-core@0.1.20",
+    "vitest": "npm:@voidzero-dev/vite-plus-test@0.1.20"
   },
   "packageManager": "bun@1.3.13",
   "capacitor": {