notifly-sdk 3.1.2 → 3.3.0

package/src/index.tsx

@@ -1,5 +1,15 @@
 import { NativeModules, Platform } from 'react-native';
-import { type UserProperties, type EventProperties } from './types';
+import type {
+  InitializeParams,
+  EventProperties,
+  UserProperties,
+  NotificationClickListener,
+  OSNotificationClickEvent,
+} from './types';
+import EventReceiver from './events/EventReceiver';
+import { EventNames } from './constants';
+
+export type * from './types';
 
 const LINKING_ERROR =
   `The package 'notifly-sdk' doesn't seem to be linked. Make sure: \n\n` +
@@ -10,12 +20,12 @@ const LINKING_ERROR =
 // @ts-expect-error
 const isTurboModuleEnabled = global.__turboModuleProxy != null;
 
-const NotiflySdkModule = isTurboModuleEnabled
-  ? require('./NativeNotiflySdk').default
-  : NativeModules.NotiflySdk;
+const NotiflyReactNativeSdkModule = isTurboModuleEnabled
+  ? require('./NativeNotiflyReactNativeSdk').default
+  : NativeModules.NotiflyReactNativeSdk;
 
-const NotiflySdk = NotiflySdkModule
-  ? NotiflySdkModule
+const NotiflyReactNativeSdk = NotiflyReactNativeSdkModule
+  ? NotiflyReactNativeSdkModule
   : new Proxy(
       {},
       {
@@ -25,31 +35,27 @@ const NotiflySdk = NotiflySdkModule
       }
     );
 
-export function multiply(a: number, b: number): Promise<number> {
-  return NotiflySdk.multiply(a, b);
-}
+const eventReceiver =
+  NotiflyReactNativeSdkModule && Platform.OS === 'android'
+    ? new EventReceiver(NotiflyReactNativeSdkModule)
+    : null;
 
-export function initialize(
-  projectId: string,
-  username: string,
-  password: string,
-  useCustomClickHandler: boolean | undefined = undefined
-): Promise<void> {
-  // @deprecated useCustomClickHandler is deprecated since version 2.3.0
-  if (typeof useCustomClickHandler !== 'undefined') {
-    console.warn(
-      'Warning: useCustomClickHandler of notifly.initialize is deprecated and will be removed in the next major release.'
-    );
-  }
-  return NotiflySdk.initialize(projectId, username, password);
+let isNativeNotificationClickListenerRegistered = false;
+
+export function initialize(params: InitializeParams): Promise<void> {
+  return NotiflyReactNativeSdk.initialize(
+    params.projectId,
+    params.username,
+    params.password
+  );
 }
 
-export function setUserId(userId: string | undefined): Promise<void> {
-  return NotiflySdk.setUserId(userId);
+export function setUserId(userId: string | null | undefined): Promise<void> {
+  return NotiflyReactNativeSdk.setUserId(userId);
 }
 
 export function setUserProperties(properties: UserProperties): Promise<void> {
-  return NotiflySdk.setUserProperties(properties);
+  return NotiflyReactNativeSdk.setUserProperties(properties);
 }
 
 export function trackEvent(
@@ -57,7 +63,7 @@ export function trackEvent(
   eventParams: EventProperties | null | undefined = undefined,
   segmentationEventParamKeys: string[] | undefined | null = null
 ): Promise<void> {
-  return NotiflySdk.trackEvent(
+  return NotiflyReactNativeSdk.trackEvent(
     eventName,
     eventParams,
     segmentationEventParamKeys
@@ -67,41 +73,40 @@ export function trackEvent(
 export function setLogLevel(logLevel: number): Promise<void> {
   // only implemented on Android
   if (Platform.OS === 'android') {
-    return NotiflySdk.setLogLevel(logLevel);
+    return NotiflyReactNativeSdk.setLogLevel(logLevel);
+  } else {
+    console.error(
+      '[Notifly React Native SDK] setLogLevel is only supported on Android.'
+    );
   }
   return Promise.resolve();
 }
 
-/**
- * @deprecated Since version 2.3.0.
- */
-export function notiflyBackgroundHandler(_remoteMessage: any): Promise<void> {
-  console.warn(
-    'Warning: notifly.notiflyBackgroundHandler(remoteMessage) is deprecated and will be removed in the next major release. You do not need to call this method anymore. remoteMessage is now handled automatically.'
-  );
-  return Promise.resolve();
-}
-
-/**
- * @deprecated Since version 2.3.0.
- */
-export function setNotiflyBackgroundMessageHandler(): Promise<void> {
-  console.warn(
-    'Warning: notifly.setNotiflyBackgroundMessageHandler() is deprecated and will be removed in the next major release. You do not need to call this method anymore. remoteMessage is now handled automatically.'
-  );
-  return Promise.resolve();
-}
-
 export function disableInAppMessage(): Promise<void> {
-  return NotiflySdk.disableInAppMessage();
+  return NotiflyReactNativeSdk.disableInAppMessage();
 }
 
-export function registerFCMToken(token: string): Promise<void> {
-  if (Platform.OS === 'android') {
-    console.warn('Warning: registerFCMToken is only supported on iOS.');
-    return Promise.resolve();
+export function addNotificationClickListener(
+  listener: NotificationClickListener
+): Promise<void> {
+  if (eventReceiver) {
+    // only implemented on Android
+    eventReceiver.addEventListener<OSNotificationClickEvent>(
+      EventNames.NOTIFICATION_CLICKED,
+      listener
+    );
+
+    if (!isNativeNotificationClickListenerRegistered) {
+      NotiflyReactNativeSdk.addNotificationClickListener();
+      isNativeNotificationClickListenerRegistered = true;
+    }
+  } else {
+    console.error(
+      '[Notifly React Native SDK] addNotificationClickListener is only supported on Android.'
+    );
   }
-  return NotiflySdk.registerFCMToken(token);
+
+  return Promise.resolve();
 }
 
 const notifly = {
@@ -110,10 +115,8 @@ const notifly = {
   setUserProperties,
   trackEvent,
   setLogLevel,
-  notiflyBackgroundHandler,
-  setNotiflyBackgroundMessageHandler,
   disableInAppMessage,
-  registerFCMToken,
+  addNotificationClickListener,
 };
 
 export default notifly;

package/src/types/index.ts

@@ -0,0 +1,15 @@
+export * from './notification';
+
+export interface InitializeParams {
+  projectId: string;
+  username: string;
+  password: string;
+}
+
+export interface UserProperties {
+  [key: string]: any;
+}
+
+export interface EventProperties {
+  [key: string]: any;
+}

package/src/types/notification.ts

@@ -0,0 +1,40 @@
+export type NotificationClickListener = (
+  event: OSNotificationClickEvent
+) => void;
+
+export enum OSNotificationImportance {
+  LOW = 0,
+  NORMAL = 1,
+  HIGH = 2,
+}
+
+export interface OSNotificationClickEvent {
+  notification: OSNotification;
+}
+
+export interface OSNotification {
+  // The Notifly message ID of the notification.
+  notiflyMessageId?: string;
+  // (Only Android) The Android system notification ID of the notification.
+  androidNotificationId?: number;
+  // Notifly campaign ID where the notification was sent from.
+  campaignId?: string;
+  // Notification title
+  title?: string;
+  // Notification body
+  body?: string;
+  // (Only Android) Importance of the notification.
+  importance?: OSNotificationImportance;
+  // URL included in the notification.
+  url?: string;
+  // URL to the image included in the notification.
+  imageUrl?: string;
+  // Sent time of the notification in milliseconds since epoch
+  sentTime?: number;
+  // TTL of the notification in seconds
+  ttl?: number;
+  // Customized data included in the notification.
+  customData?: { [key: string]: any };
+  // Raw payload of the notification.
+  rawPayload?: { [key: string]: any };
+}

package/lib/commonjs/NativeNotiflySdk.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_reactNative","require","_default","TurboModuleRegistry","getEnforcing","exports","default"],"sourceRoot":"../../src","sources":["NativeNotiflySdk.ts"],"mappings":";;;;;;AACA,IAAAA,YAAA,GAAAC,OAAA;AAAmD,IAAAC,QAAA,GAyBpCC,gCAAmB,CAACC,YAAY,CAAO,YAAY,CAAC;AAAAC,OAAA,CAAAC,OAAA,GAAAJ,QAAA"}

package/lib/commonjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=types.js.map

package/lib/commonjs/types.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sourceRoot":"../../src","sources":["types.ts"],"mappings":""}

package/lib/module/NativeNotiflySdk.js

@@ -1,3 +0,0 @@
-import { TurboModuleRegistry } from 'react-native';
-export default TurboModuleRegistry.getEnforcing('NotiflySdk');
-//# sourceMappingURL=NativeNotiflySdk.js.map

package/lib/module/NativeNotiflySdk.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeNotiflySdk.ts"],"mappings":"AACA,SAASA,mBAAmB,QAAQ,cAAc;AAyBlD,eAAeA,mBAAmB,CAACC,YAAY,CAAO,YAAY,CAAC"}

package/lib/module/types.js

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=types.js.map

package/lib/module/types.js.map

@@ -1 +0,0 @@
-{"version":3,"names":[],"sourceRoot":"../../src","sources":["types.ts"],"mappings":""}

package/lib/typescript/NativeNotiflySdk.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativeNotiflySdk.d.ts","sourceRoot":"","sources":["../../src/NativeNotiflySdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,SAAS,CAAC;AAEpE,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,qBAAqB,EAAE,OAAO,GAAG,SAAS,GACzC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,EAC/C,0BAA0B,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI,GACtD,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,wBAAwB,CAAC,cAAc,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD;;AAED,wBAAoE"}

package/lib/typescript/types.d.ts

@@ -1,7 +0,0 @@
-export interface UserProperties {
-    [key: string]: any;
-}
-export interface EventProperties {
-    [key: string]: any;
-}
-//# sourceMappingURL=types.d.ts.map

package/lib/typescript/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}

package/src/types.ts

@@ -1,7 +0,0 @@
-export interface UserProperties {
-  [key: string]: any;
-}
-
-export interface EventProperties {
-  [key: string]: any;
-}