@onesignal/onesignal-vue3 2.0.0 → 2.1.0

package/index.ts

@@ -10,7 +10,7 @@ let isOneSignalInitialized = false;
 // OneSignal#init.
 let isOneSignalScriptFailed = false;
 
-if (window) {
+if (typeof window !== 'undefined') {
   window.OneSignalDeferred = window.OneSignalDeferred || [];
   addSDKScript();
 }
@@ -171,7 +171,7 @@ interface IOSNotification {
    * If this value is the same as existing notification, it will replace it
    * Can be set when creating the notification with "Web Push Topic" on the dashboard
    * or web_push_topic from the REST API.
-  */
+   */
   readonly topic?: string;
 
   /**
@@ -223,7 +223,7 @@ type NotificationEventTypeMap = {
   'dismiss': NotificationDismissEvent;
   'permissionChange': boolean;
   'permissionPromptDisplay': void;
-}
+};
 
 interface NotificationForegroundWillDisplayEvent {
   readonly notification: IOSNotification;
@@ -239,6 +239,13 @@ interface NotificationClickEvent {
   readonly result: NotificationClickResult;
 }
 
+type UserChangeEvent = {
+  current: UserNamespaceProperties;
+};
+type UserNamespaceProperties = {
+  onesignalId: string | undefined;
+  externalId: string | undefined;
+};
 
 interface IInitObject {
   appId: string;
@@ -253,10 +260,11 @@ interface IInitObject {
   autoRegister?: boolean;
   notificationClickHandlerMatch?: string;
   notificationClickHandlerAction?: string;
+  path?: string;
   serviceWorkerParam?: { scope: string };
   serviceWorkerPath?: string;
+  serviceWorkerOverrideForTypical?: boolean;
   serviceWorkerUpdaterPath?: string;
-  path?: string;
   allowLocalhostAsSecureOrigin?: boolean;
   [key: string]: any;
 }
@@ -300,6 +308,8 @@ interface IOneSignalSession {
 	sendUniqueOutcome(outcomeName: string): Promise<void>;
 }
 interface IOneSignalUser {
+	onesignalId: string | undefined;
+	externalId: string | undefined;
 	PushSubscription: IOneSignalPushSubscription;
 	addAlias(label: string, id: string): void;
 	addAliases(aliases: { [key: string]: string }): void;
@@ -313,6 +323,11 @@ interface IOneSignalUser {
 	addTags(tags: { [key: string]: string }): void;
 	removeTag(key: string): void;
 	removeTags(keys: string[]): void;
+	getTags(): { [key: string]: string };
+	addEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void;
+	removeEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void;
+	setLanguage(language: string): void;
+	getLanguage(): string;
 }
 interface IOneSignalPushSubscription {
 	id: string | null | undefined;
@@ -323,17 +338,16 @@ interface IOneSignalPushSubscription {
 	addEventListener(event: 'change', listener: (change: SubscriptionChangeEvent) => void): void;
 	removeEventListener(event: 'change', listener: (change: SubscriptionChangeEvent) => void): void;
 }
-
 function oneSignalLogin(externalId: string, jwtToken?: string): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.login(externalId, jwtToken)
-          .then(value => resolve(value))
+        OneSignal.login(externalId, jwtToken).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -341,17 +355,16 @@ function oneSignalLogin(externalId: string, jwtToken?: string): Promise<void> {
     }
   });
 }
-
 function oneSignalLogout(): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.logout()
-          .then(value => resolve(value))
+        OneSignal.logout().then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -359,17 +372,16 @@ function oneSignalLogout(): Promise<void> {
     }
   });
 }
-
 function oneSignalSetConsentGiven(consent: boolean): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.setConsentGiven(consent)
-          .then(value => resolve(value))
+        OneSignal.setConsentGiven(consent).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -377,17 +389,16 @@ function oneSignalSetConsentGiven(consent: boolean): Promise<void> {
     }
   });
 }
-
 function oneSignalSetConsentRequired(requiresConsent: boolean): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.setConsentRequired(requiresConsent)
-          .then(value => resolve(value))
+        OneSignal.setConsentRequired(requiresConsent).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -395,17 +406,16 @@ function oneSignalSetConsentRequired(requiresConsent: boolean): Promise<void> {
     }
   });
 }
-
 function slidedownPromptPush(options?: AutoPromptOptions): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Slidedown.promptPush(options)
-          .then(value => resolve(value))
+        OneSignal.Slidedown.promptPush(options).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -413,17 +423,16 @@ function slidedownPromptPush(options?: AutoPromptOptions): Promise<void> {
     }
   });
 }
-
 function slidedownPromptPushCategories(options?: AutoPromptOptions): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Slidedown.promptPushCategories(options)
-          .then(value => resolve(value))
+        OneSignal.Slidedown.promptPushCategories(options).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -431,17 +440,16 @@ function slidedownPromptPushCategories(options?: AutoPromptOptions): Promise<voi
     }
   });
 }
-
 function slidedownPromptSms(options?: AutoPromptOptions): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Slidedown.promptSms(options)
-          .then(value => resolve(value))
+        OneSignal.Slidedown.promptSms(options).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -449,17 +457,16 @@ function slidedownPromptSms(options?: AutoPromptOptions): Promise<void> {
     }
   });
 }
-
 function slidedownPromptEmail(options?: AutoPromptOptions): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Slidedown.promptEmail(options)
-          .then(value => resolve(value))
+        OneSignal.Slidedown.promptEmail(options).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -467,17 +474,16 @@ function slidedownPromptEmail(options?: AutoPromptOptions): Promise<void> {
     }
   });
 }
-
 function slidedownPromptSmsAndEmail(options?: AutoPromptOptions): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Slidedown.promptSmsAndEmail(options)
-          .then(value => resolve(value))
+        OneSignal.Slidedown.promptSmsAndEmail(options).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -485,29 +491,30 @@ function slidedownPromptSmsAndEmail(options?: AutoPromptOptions): Promise<void>
     }
   });
 }
-
 function slidedownAddEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.Slidedown.addEventListener(event, listener)
+    OneSignal.Slidedown.addEventListener(event, listener);
   });
+  
 }
-
 function slidedownRemoveEventListener(event: SlidedownEventName, listener: (wasShown: boolean) => void): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.Slidedown.removeEventListener(event, listener)
+    OneSignal.Slidedown.removeEventListener(event, listener);
   });
+  
 }
-
 function notificationsSetDefaultUrl(url: string): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Notifications.setDefaultUrl(url)
-          .then(value => resolve(value))
+        OneSignal.Notifications.setDefaultUrl(url).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -515,17 +522,16 @@ function notificationsSetDefaultUrl(url: string): Promise<void> {
     }
   });
 }
-
 function notificationsSetDefaultTitle(title: string): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Notifications.setDefaultTitle(title)
-          .then(value => resolve(value))
+        OneSignal.Notifications.setDefaultTitle(title).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -533,17 +539,16 @@ function notificationsSetDefaultTitle(title: string): Promise<void> {
     }
   });
 }
-
 function notificationsRequestPermission(): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Notifications.requestPermission()
-          .then(value => resolve(value))
+        OneSignal.Notifications.requestPermission().then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -551,29 +556,30 @@ function notificationsRequestPermission(): Promise<void> {
     }
   });
 }
-
 function notificationsAddEventListener<K extends NotificationEventName>(event: K, listener: (obj: NotificationEventTypeMap[K]) => void): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.Notifications.addEventListener(event, listener)
+    OneSignal.Notifications.addEventListener(event, listener);
   });
+  
 }
-
 function notificationsRemoveEventListener<K extends NotificationEventName>(event: K, listener: (obj: NotificationEventTypeMap[K]) => void): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.Notifications.removeEventListener(event, listener)
+    OneSignal.Notifications.removeEventListener(event, listener);
   });
+  
 }
-
 function sessionSendOutcome(outcomeName: string, outcomeWeight?: number): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Session.sendOutcome(outcomeName, outcomeWeight)
-          .then(value => resolve(value))
+        OneSignal.Session.sendOutcome(outcomeName, outcomeWeight).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -581,17 +587,16 @@ function sessionSendOutcome(outcomeName: string, outcomeWeight?: number): Promis
     }
   });
 }
-
 function sessionSendUniqueOutcome(outcomeName: string): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.Session.sendUniqueOutcome(outcomeName)
-          .then(value => resolve(value))
+        OneSignal.Session.sendUniqueOutcome(outcomeName).then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -599,89 +604,135 @@ function sessionSendUniqueOutcome(outcomeName: string): Promise<void> {
     }
   });
 }
-
 function userAddAlias(label: string, id: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.addAlias(label, id)
+    OneSignal.User.addAlias(label, id);
   });
+  
 }
-
 function userAddAliases(aliases: { [key: string]: string }): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.addAliases(aliases)
+    OneSignal.User.addAliases(aliases);
   });
+  
 }
-
 function userRemoveAlias(label: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.removeAlias(label)
+    OneSignal.User.removeAlias(label);
   });
+  
 }
-
 function userRemoveAliases(labels: string[]): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.removeAliases(labels)
+    OneSignal.User.removeAliases(labels);
   });
+  
 }
-
 function userAddEmail(email: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.addEmail(email)
+    OneSignal.User.addEmail(email);
   });
+  
 }
-
 function userRemoveEmail(email: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.removeEmail(email)
+    OneSignal.User.removeEmail(email);
   });
+  
 }
-
 function userAddSms(smsNumber: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.addSms(smsNumber)
+    OneSignal.User.addSms(smsNumber);
   });
+  
 }
-
 function userRemoveSms(smsNumber: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.removeSms(smsNumber)
+    OneSignal.User.removeSms(smsNumber);
   });
+  
 }
-
 function userAddTag(key: string, value: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.addTag(key, value)
+    OneSignal.User.addTag(key, value);
   });
+  
 }
-
 function userAddTags(tags: { [key: string]: string }): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.addTags(tags)
+    OneSignal.User.addTags(tags);
   });
+  
 }
-
 function userRemoveTag(key: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.removeTag(key)
+    OneSignal.User.removeTag(key);
   });
+  
 }
-
 function userRemoveTags(keys: string[]): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.removeTags(keys)
+    OneSignal.User.removeTags(keys);
   });
+  
+}
+function userGetTags(): { [key: string]: string } {
+  let retVal: { [key: string]: string };
+  window.OneSignalDeferred?.push((OneSignal) => {
+    retVal = OneSignal.User.getTags();
+  });
+  return retVal;
+}
+function userAddEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void {
+  
+  window.OneSignalDeferred?.push((OneSignal) => {
+    OneSignal.User.addEventListener(event, listener);
+  });
+  
+}
+function userRemoveEventListener(event: 'change', listener: (change: UserChangeEvent) => void): void {
+  
+  window.OneSignalDeferred?.push((OneSignal) => {
+    OneSignal.User.removeEventListener(event, listener);
+  });
+  
+}
+function userSetLanguage(language: string): void {
+  
+  window.OneSignalDeferred?.push((OneSignal) => {
+    OneSignal.User.setLanguage(language);
+  });
+  
+}
+function userGetLanguage(): string {
+  let retVal: string;
+  window.OneSignalDeferred?.push((OneSignal) => {
+    retVal = OneSignal.User.getLanguage();
+  });
+  return retVal;
 }
-
 function pushSubscriptionOptIn(): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.User.PushSubscription.optIn()
-          .then(value => resolve(value))
+        OneSignal.User.PushSubscription.optIn().then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -689,17 +740,16 @@ function pushSubscriptionOptIn(): Promise<void> {
     }
   });
 }
-
 function pushSubscriptionOptOut(): Promise<void> {
   return new Promise(function (resolve, reject) {
     if (isOneSignalScriptFailed) {
-      reject();
+      reject(new Error('OneSignal script failed to load.'));
+      return;
     }
 
     try {
       window.OneSignalDeferred?.push((OneSignal) => {
-        OneSignal.User.PushSubscription.optOut()
-          .then(value => resolve(value))
+        OneSignal.User.PushSubscription.optOut().then(() => resolve())
           .catch(error => reject(error));
       });
     } catch (error) {
@@ -707,28 +757,31 @@ function pushSubscriptionOptOut(): Promise<void> {
     }
   });
 }
-
 function pushSubscriptionAddEventListener(event: 'change', listener: (change: SubscriptionChangeEvent) => void): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.PushSubscription.addEventListener(event, listener)
+    OneSignal.User.PushSubscription.addEventListener(event, listener);
   });
+  
 }
-
 function pushSubscriptionRemoveEventListener(event: 'change', listener: (change: SubscriptionChangeEvent) => void): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.User.PushSubscription.removeEventListener(event, listener)
+    OneSignal.User.PushSubscription.removeEventListener(event, listener);
   });
+  
 }
-
 function debugSetLogLevel(logLevel: string): void {
+  
   window.OneSignalDeferred?.push((OneSignal) => {
-    OneSignal.Debug.setLogLevel(logLevel)
+    OneSignal.Debug.setLogLevel(logLevel);
   });
+  
 }
 const PushSubscriptionNamespace: IOneSignalPushSubscription = {
-	get id(): string | null | undefined { return window.OneSignal?.User?.PushSubscription?.id },
-	get token(): string | null | undefined { return window.OneSignal?.User?.PushSubscription?.token },
-	get optedIn(): boolean | undefined { return window.OneSignal?.User?.PushSubscription?.optedIn },
+	get id(): string | null | undefined { return window.OneSignal?.User?.PushSubscription?.id; },
+	get token(): string | null | undefined { return window.OneSignal?.User?.PushSubscription?.token; },
+	get optedIn(): boolean | undefined { return window.OneSignal?.User?.PushSubscription?.optedIn; },
 	optIn: pushSubscriptionOptIn,
 	optOut: pushSubscriptionOptOut,
 	addEventListener: pushSubscriptionAddEventListener,
@@ -736,6 +789,8 @@ const PushSubscriptionNamespace: IOneSignalPushSubscription = {
 };
 
 const UserNamespace: IOneSignalUser = {
+	get onesignalId(): string | undefined { return window.OneSignal?.User?.onesignalId; },
+	get externalId(): string | undefined { return window.OneSignal?.User?.externalId; },
 	addAlias: userAddAlias,
 	addAliases: userAddAliases,
 	removeAlias: userRemoveAlias,
@@ -748,6 +803,11 @@ const UserNamespace: IOneSignalUser = {
 	addTags: userAddTags,
 	removeTag: userRemoveTag,
 	removeTags: userRemoveTags,
+	getTags: userGetTags,
+	addEventListener: userAddEventListener,
+	removeEventListener: userRemoveEventListener,
+	setLanguage: userSetLanguage,
+	getLanguage: userGetLanguage,
 	PushSubscription: PushSubscriptionNamespace,
 };
 

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@onesignal/onesignal-vue3",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Vue 3 OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!",
   "author": "rgomezp",
   "contributors": [
-    { "name": "Rodrigo Gomez-Palacio" },
-    { "name": "Enzo Innocenzi" }
+    {
+      "name": "Rodrigo Gomez-Palacio"
+    },
+    {
+      "name": "Enzo Innocenzi"
+    }
   ],
   "license": "MIT",
   "repository": "OneSignal/onesignal-vue3",