@onesignal/onesignal-vue3 2.2.1 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [2.3.0](https://github.com/OneSignal/onesignal-vue3/compare/2.2.2...2.3.0) (2025-09-19)
+
+### Features
+
+* add new custom events `trackEvent` method ([aaac2d8](https://github.com/OneSignal/onesignal-vue3/commit/aaac2d8b45e6aef390d2fd03e3372aa417556705))
+
+## [2.2.2](https://github.com/OneSignal/onesignal-vue3/compare/2.2.1...2.2.2) (2025-06-06)
+
+### Bug Fixes
+
+* sync with web-shim-codegen v3.0.5 ([127de33](https://github.com/OneSignal/onesignal-vue3/commit/127de33d807f0458fe2471401c192e5b3d824ef3))
+
 ## [2.2.1](https://github.com/OneSignal/onesignal-vue3/compare/2.2.0...2.2.1) (2025-03-28)
 
 ### Bug Fixes

package/README.md

@@ -1,7 +1,7 @@
 <h1 align="center">Welcome to onesignal-vue3 👋</h1>
 <p>
-  <a href="https://www.npmjs.com/package/onesignal-vue3" target="_blank">
-    <img alt="Version" src="https://img.shields.io/npm/v/onesignal-vue3.svg">
+  <a href="https://www.npmjs.com/package/@onesignal/onesignal-vue3" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/@onesignal/onesignal-vue3.svg">
   </a>
   <a href="https://github.com/OneSignal/onesignal-vue3#readme" target="_blank">
     <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
@@ -19,7 +19,7 @@
 - 🏠 [Homepage](https://onesignal.com)
 - 🖤 [npm](https://www.npmjs.com/package/@onesignal/onesignal-vue3)
 
-OneSignal is the world's leader for Mobile Push Notifications, Web Push, and In-App Messaging. It is trusted by 2 million+ businesses to send 9 billion Push Notifications per day.
+OneSignal is the world's leader for Mobile Push Notifications, Web Push, and In-App Messaging. It is trusted by 2 million+ developers to send 12 billion Push Notifications per day.
 
 You can find more information on OneSignal [here](https://onesignal.com/).
 
@@ -130,7 +130,7 @@ this.$OneSignal
 
 ### Init Options
 
-You can pass other [options](https://documentation.onesignal.com/v11.0/docs/web-sdk#initializing-the-sdk) to the `init` function. Use these options to configure personalized prompt options, auto-resubscribe, and more.
+You can pass other [options](https://documentation.onesignal.com/docs/web-sdk-reference#init) to the `init` function. Use these options to configure personalized prompt options, auto-resubscribe, and more.
 
 <details>
   <summary>Expand to see more options</summary>
@@ -205,7 +205,7 @@ interface IOneSignalOneSignal {
 
 ### OneSignal API
 
-See the official [OneSignal WebSDK reference](https://documentation.onesignal.com/v11.0/docs/web-sdk) for information on all available SDK functions.
+See the official [OneSignal WebSDK reference](https://documentation.onesignal.com/docs/web-sdk) for information on all available SDK functions.
 
 ---
 
@@ -245,7 +245,7 @@ this.$OneSignal.Notifications.addEventListener('change', (event) => {
 });
 ```
 
-See the [OneSignal WebSDK Reference](https://documentation.onesignal.com/v11.0/docs/web-sdk) for all available event listeners.
+See the [OneSignal WebSDK Reference](https://documentation.onesignal.com/docs/web-sdk-reference#addeventlistener-push-notification) for all available event listeners.
 
 ---
 

package/dist/index.d.ts

@@ -221,8 +221,13 @@ export interface IInitObject {
     welcomeNotification?: {
         /**
          * Disables sending a welcome notification to new site visitors. If you want to disable welcome notifications, this is the only option you need.
+         * @deprecated Use 'disable' instead. This will be removed in a future version.
          */
         disabled?: boolean;
+        /**
+         * Disables sending a welcome notification to new site visitors. If you want to disable welcome notifications, this is the only option you need.
+         */
+        disable?: boolean;
         /**
          * The welcome notification's message. You can localize this to your own language.
          * If left blank or set to blank, the default of 'Thanks for subscribing!' will be used.
@@ -237,7 +242,7 @@ export interface IInitObject {
          * By default, clicking the welcome notification does not open any link.
          * This is recommended because the user has just visited your site and subscribed.
          */
-        url: string;
+        url?: string;
     };
     /**
      * Will enable customization of the notify/subscription bell button.
@@ -347,7 +352,7 @@ export interface IOneSignalNotifications {
     setDefaultUrl(url: string): Promise<void>;
     setDefaultTitle(title: string): Promise<void>;
     isPushSupported(): boolean;
-    requestPermission(): Promise<void>;
+    requestPermission(): Promise<boolean>;
     addEventListener<K extends NotificationEventName>(event: K, listener: (obj: NotificationEventTypeMap[K]) => void): void;
     removeEventListener<K extends NotificationEventName>(event: K, listener: (obj: NotificationEventTypeMap[K]) => void): void;
 }
@@ -361,7 +366,7 @@ export interface IOneSignalSlidedown {
     removeEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void;
 }
 export interface IOneSignalDebug {
-    setLogLevel(logLevel: string): void;
+    setLogLevel(logLevel: 'trace' | 'debug' | 'info' | 'warn' | 'error'): void;
 }
 export interface IOneSignalSession {
     sendOutcome(outcomeName: string, outcomeWeight?: number): Promise<void>;
@@ -394,6 +399,7 @@ export interface IOneSignalUser {
     removeEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void;
     setLanguage(language: string): void;
     getLanguage(): string;
+    trackEvent(name: string, properties?: Record<string, unknown>): void;
 }
 export interface IOneSignalPushSubscription {
     id: string | null | undefined;

package/dist/index.js

@@ -1,3 +1,12 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 const ONESIGNAL_SDK_ID = 'onesignal-sdk';
 const ONE_SIGNAL_SCRIPT_SRC = 'https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js';
 // true if the script is successfully loaded from CDN.
@@ -31,6 +40,7 @@ function addSDKScript() {
  * @PublicApi
  */
 const init = (options) => {
+    var _a;
     if (isOneSignalInitialized) {
         return Promise.reject(`OneSignal is already initialized.`);
     }
@@ -40,6 +50,10 @@ const init = (options) => {
     if (!document) {
         return Promise.reject(`Document is not defined.`);
     }
+    // Handle both disabled and disable keys for welcome notification
+    if (((_a = options.welcomeNotification) === null || _a === void 0 ? void 0 : _a.disabled) !== undefined) {
+        options.welcomeNotification.disable = options.welcomeNotification.disabled;
+    }
     return new Promise((resolve, reject) => {
         var _a;
         (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
@@ -84,165 +98,129 @@ const isPushSupported = () => {
     return isPushNotificationsSupported();
 };
 function oneSignalLogin(externalId, jwtToken) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.login(externalId, jwtToken).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.login(externalId, jwtToken)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function oneSignalLogout() {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.logout().then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.logout()
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function oneSignalSetConsentGiven(consent) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.setConsentGiven(consent).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.setConsentGiven(consent)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function oneSignalSetConsentRequired(requiresConsent) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.setConsentRequired(requiresConsent).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.setConsentRequired(requiresConsent)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function slidedownPromptPush(options) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptPush(options).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Slidedown.promptPush(options)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function slidedownPromptPushCategories(options) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptPushCategories(options).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Slidedown.promptPushCategories(options)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function slidedownPromptSms(options) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptSms(options).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Slidedown.promptSms(options)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function slidedownPromptEmail(options) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptEmail(options).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Slidedown.promptEmail(options)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function slidedownPromptSmsAndEmail(options) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Slidedown.promptSmsAndEmail(options).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Slidedown.promptSmsAndEmail(options)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function slidedownAddEventListener(event, listener) {
@@ -258,57 +236,45 @@ function slidedownRemoveEventListener(event, listener) {
     });
 }
 function notificationsSetDefaultUrl(url) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Notifications.setDefaultUrl(url).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Notifications.setDefaultUrl(url)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function notificationsSetDefaultTitle(title) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Notifications.setDefaultTitle(title).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Notifications.setDefaultTitle(title)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function notificationsRequestPermission() {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Notifications.requestPermission().then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Notifications.requestPermission()
+                .then(result => resolve(result))
+                .catch(error => reject(error));
+        });
     });
 }
 function notificationsAddEventListener(event, listener) {
@@ -324,39 +290,31 @@ function notificationsRemoveEventListener(event, listener) {
     });
 }
 function sessionSendOutcome(outcomeName, outcomeWeight) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Session.sendOutcome(outcomeName, outcomeWeight).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Session.sendOutcome(outcomeName, outcomeWeight)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function sessionSendUniqueOutcome(outcomeName) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.Session.sendUniqueOutcome(outcomeName).then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.Session.sendUniqueOutcome(outcomeName)
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function userAddAlias(label, id) {
@@ -431,13 +389,16 @@ function userRemoveTags(keys) {
         OneSignal.User.removeTags(keys);
     });
 }
+// @ts-expect-error - return non-Promise type despite needing to await OneSignalDeferred
 function userGetTags() {
     var _a;
-    let retVal;
-    (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-        retVal = OneSignal.User.getTags();
+    return __awaiter(this, void 0, void 0, function* () {
+        let retVal;
+        yield ((_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            retVal = OneSignal.User.getTags();
+        }));
+        return retVal;
     });
-    return retVal;
 }
 function userAddEventListener(event, listener) {
     var _a;
@@ -457,48 +418,49 @@ function userSetLanguage(language) {
         OneSignal.User.setLanguage(language);
     });
 }
+// @ts-expect-error - return non-Promise type despite needing to await OneSignalDeferred
 function userGetLanguage() {
     var _a;
-    let retVal;
+    return __awaiter(this, void 0, void 0, function* () {
+        let retVal;
+        yield ((_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            retVal = OneSignal.User.getLanguage();
+        }));
+        return retVal;
+    });
+}
+function userTrackEvent(name, properties) {
+    var _a;
     (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-        retVal = OneSignal.User.getLanguage();
+        OneSignal.User.trackEvent(name, properties);
     });
-    return retVal;
 }
 function pushSubscriptionOptIn() {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.User.PushSubscription.optIn().then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.User.PushSubscription.optIn()
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function pushSubscriptionOptOut() {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
         var _a;
         if (isOneSignalScriptFailed) {
             reject(new Error('OneSignal script failed to load.'));
             return;
         }
-        try {
-            (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
-                OneSignal.User.PushSubscription.optOut().then(() => resolve())
-                    .catch(error => reject(error));
-            });
-        }
-        catch (error) {
-            reject(error);
-        }
+        (_a = window.OneSignalDeferred) === null || _a === void 0 ? void 0 : _a.push((OneSignal) => {
+            OneSignal.User.PushSubscription.optOut()
+                .then(() => resolve())
+                .catch(error => reject(error));
+        });
     });
 }
 function pushSubscriptionAddEventListener(event, listener) {
@@ -548,6 +510,7 @@ const UserNamespace = {
     removeEventListener: userRemoveEventListener,
     setLanguage: userSetLanguage,
     getLanguage: userGetLanguage,
+    trackEvent: userTrackEvent,
     PushSubscription: PushSubscriptionNamespace,
 };
 const SessionNamespace = {