Merge pull request #124 from OneSignal/fadi/sdk-2946-add-custom-events-for-onesignal-react-package

feat: add custom events for web packages

Author: fadi-george

scripts/build

@@ -53,7 +53,11 @@ mv build/vue/v3.tgz dist/vue/v3.tgz
 
 # This is required to use 'npm link' when testing local builds
 # We do this last so unneed files are not included in the releases.
-log '👀 Install and Linting'
-concurrently --kill-others-on-fail "npm ci --loglevel=error --prefix=build/vue/v3" "npm ci --loglevel=error --prefix=build/vue/v2" "npm ci --loglevel=error --prefix=build/react" "npm i --prefix=build/onesignal-ngx"
-
-log '✅ Done!'
+log '👀 Install + Linting + Build'
+
+if concurrently --kill-others-on-fail "npm ci --loglevel=error --prefix=build/vue/v3" "npm ci --loglevel=error --prefix=build/vue/v2" "npm ci --loglevel=error --prefix=build/react" "npm i --prefix=build/onesignal-ngx"; then
+  log '✅ Done!'
+else
+  log '❌ Build failed!'
+  exit 1
+fi

src/scaffolds/angular-workspace/projects/onesignal-ngx/src/lib/onesignal-ngx.service.ts

@@ -353,7 +353,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;
 }
@@ -394,6 +394,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;
@@ -405,119 +406,128 @@ export interface IOneSignalPushSubscription {
 	removeEventListener(event: 'change', listener: (change: SubscriptionChangeEvent) => void): void;
 }
 function oneSignalLogin(externalId: string, jwtToken?: string): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.login(externalId, jwtToken).then(() => resolve());
+      oneSignal.login(externalId, jwtToken)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function oneSignalLogout(): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.logout().then(() => resolve());
+      oneSignal.logout()
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function oneSignalSetConsentGiven(consent: boolean): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.setConsentGiven(consent).then(() => resolve());
+      oneSignal.setConsentGiven(consent)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function oneSignalSetConsentRequired(requiresConsent: boolean): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.setConsentRequired(requiresConsent).then(() => resolve());
+      oneSignal.setConsentRequired(requiresConsent)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function slidedownPromptPush(options?: AutoPromptOptions): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Slidedown.promptPush(options).then(() => resolve());
+      oneSignal.Slidedown.promptPush(options)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function slidedownPromptPushCategories(options?: AutoPromptOptions): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Slidedown.promptPushCategories(options).then(() => resolve());
+      oneSignal.Slidedown.promptPushCategories(options)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function slidedownPromptSms(options?: AutoPromptOptions): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Slidedown.promptSms(options).then(() => resolve());
+      oneSignal.Slidedown.promptSms(options)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function slidedownPromptEmail(options?: AutoPromptOptions): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Slidedown.promptEmail(options).then(() => resolve());
+      oneSignal.Slidedown.promptEmail(options)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function slidedownPromptSmsAndEmail(options?: AutoPromptOptions): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Slidedown.promptSmsAndEmail(options).then(() => resolve());
+      oneSignal.Slidedown.promptSmsAndEmail(options)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
@@ -534,41 +544,44 @@ function slidedownRemoveEventListener(event: SlidedownEventName, listener: (wasS
 }
 
 function notificationsSetDefaultUrl(url: string): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Notifications.setDefaultUrl(url).then(() => resolve());
+      oneSignal.Notifications.setDefaultUrl(url)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function notificationsSetDefaultTitle(title: string): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Notifications.setDefaultTitle(title).then(() => resolve());
+      oneSignal.Notifications.setDefaultTitle(title)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
-function notificationsRequestPermission(): Promise<void> {
-  
+function notificationsRequestPermission(): Promise<boolean> {
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Notifications.requestPermission().then(() => resolve());
+      oneSignal.Notifications.requestPermission()
+        .then(result => resolve(result))
+        .catch(error => reject(error));
     });
   });
 }
@@ -585,28 +598,30 @@ function notificationsRemoveEventListener<K extends NotificationEventName>(event
 }
 
 function sessionSendOutcome(outcomeName: string, outcomeWeight?: number): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Session.sendOutcome(outcomeName, outcomeWeight).then(() => resolve());
+      oneSignal.Session.sendOutcome(outcomeName, outcomeWeight)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function sessionSendUniqueOutcome(outcomeName: string): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.Session.sendUniqueOutcome(outcomeName).then(() => resolve());
+      oneSignal.Session.sendUniqueOutcome(outcomeName)
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
@@ -720,29 +735,37 @@ async function userGetLanguage(): string {
   return retVal;
 }
 
+function userTrackEvent(name: string, properties?: Record<string, unknown>): void {
+  window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
+    oneSignal.User.trackEvent(name, properties);
+  });
+}
+
 function pushSubscriptionOptIn(): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.User.PushSubscription.optIn().then(() => resolve());
+      oneSignal.User.PushSubscription.optIn()
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
 function pushSubscriptionOptOut(): Promise<void> {
-  
   return new Promise((resolve, reject) => {
     if (isOneSignalScriptFailed) {
       reject(new Error('OneSignal script failed to load.'));
       return;
     }
 
     window.OneSignalDeferred?.push((oneSignal: IOneSignalOneSignal) => {
-      oneSignal.User.PushSubscription.optOut().then(() => resolve());
+      oneSignal.User.PushSubscription.optOut()
+        .then(() => resolve())
+        .catch(error => reject(error));
     });
   });
 }
@@ -795,6 +818,7 @@ const UserNamespace: IOneSignalUser = {
 	removeEventListener: userRemoveEventListener,
 	setLanguage: userSetLanguage,
 	getLanguage: userGetLanguage,
+	trackEvent: userTrackEvent,
 	PushSubscription: PushSubscriptionNamespace,
 };
 

src/static/react/package.json

@@ -35,7 +35,7 @@
   },
   "scripts": {
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "build": "vite build",
+    "build": "tsc --noEmit && vite build",
     "test": "vitest run",
     "prepare": "npm run lint && npm run test && npm run build"
   },