@trycourier/courier-react-native 1.0.8 → 2.0.0-beta0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 FahadAminShovon
+Copyright (c) 2023 mikemilla
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

package/README.md

@@ -1,431 +1,31 @@
-# Courier React Native Overview
+# courier-react-native
 
-```ts
-import Courier, { CourierProvider } from '@trycourier/courier-react-native'
+Inbox & Push Notifications for iOS
 
-await Courier.setIsDebugging(true);
+## Installation
 
-const userId = await Courier.userId;
-
-await Courier.signIn({
-  accessToken: 'asdf...',
-  userId: 'example_user_id',
-});
-
-await Courier.signOut();
-
-await Courier.iOSForegroundPresentationOptions({
-  options: ['badge', 'banner', 'list', 'sound'],
-});
-
-const currentPermissionStatus = await Courier.notificationPermissionStatus;
-const requestNotificationPermission = await Courier.requestNotificationPermission();
-
-await Courier.setFcmToken('asdf...');
-
-const fcmToken = await Courier.fcmToken;
-const apnsToken = await Courier.apnsToken;
-
-const unsubscribe = Courier.registerPushNotificationListeners({
-  onPushNotificationClicked(push) {
-    console.log(push);
-  },
-  onPushNotificationDelivered(push) {
-    console.log(push);
-  },
-});
-
-const messageId = await Courier.sendPush({
-  authKey: 'asdf...',
-  userId: 'example_user_id',
-  title: 'Hey! 👋',
-  body: 'Courier is awesome!!',
-  isProduction: false,
-  providers: [CourierProvider.APNS, CourierProvider.FCM],
-});
-```
-
- 
-
-# Requirements & Support
-
-
-| Operating System | Min SDK | Compile SDK | Firebase Cloud Messaging | Apple Push Notification Service | Expo | OneSignal | Courier Inbox | Courier Toast |
-| :-- |     --: |         --: |                      --: |                             --: |  --: |       --: |           --: |           --: |
-| `iOS` |  `13` |           — |                       ❌ |                               ✅ |   ❌ |         ❌ |            ❌ |            ❌ |
-| `Android` | `21` |     `32` |                       ✅ |                               ❌ |   ❌ |         ❌ |            ❌ |            ❌ |
-
-> Most of this SDK depends on a Courier account: [`Create a Courier account here`](https://app.courier.com/signup)
-
-> Testing push notifications requires a physical device. Simulators will not work.
-
- 
-
-# **Installation**
-
-> Link to [`Example App`](https://github.com/trycourier/courier-react-native/tree/master/example)
-
-1. [`Install the package`](#1-install-the-package)
-2. [`iOS Setup`](#2-ios-setup)
-3. [`Android Setup`](#3-android-setup)
-4. [`Configure Push Provider`](#4-configure-push-provider)
-5. [`Managing User State`](#5-managing-user-state)
-6. [`Going to Production`](#going-to-production)
-
- 
-
-## **1. Install the package**
-
-Run the following command at your project's root directory:
-
-using npm:
-
-```
-npm install @trycourier/courier-react-native
-```
-
-using yarn:
-
-```
-yarn add @trycourier/courier-react-native
-```
-
- 
-
-## **2. iOS Setup**
-
-> If you don't need push notification support on iOS, you can skip this step.
-
-https://user-images.githubusercontent.com/6370613/199279392-1b376929-4a03-4acd-9d00-d170085d9791.mov
-
-### Written Tutorial 👇
-
-1. Open your iOS project and increase the min SDK target to iOS 13.0+
-2. Open your `Podfile` and increase the platform:
-
-```
-..
-platform :ios, '13'
-..
-```
-
-3. From your React Native project's root directory, run: `cd ios && pod update`
-4. In Xcode, change your `AppDelegate.h` to use the snippet below:
-   - This automatically syncs APNS tokens to Courier token management
-   - Allows the React Native SDK to handle when push notifications are delivered and clicked
-
-```objective-c
-#import <courier-react-native/CourierReactNativeDelegate.h>
-
-@interface AppDelegate : CourierReactNativeDelegate
-@end
-```
-
-4. Enable the "Push Notifications" capability
-
-### **Add the Notification Service Extension (Recommended)**
-
-To make sure Courier can track when a notification is delivered to the device, you need to add a Notification Service Extension. Here is how to add one.
-
-https://user-images.githubusercontent.com/6370613/199331562-5d16e02f-2878-4f60-bbe2-075ae119c6bc.mov
-
-### Written Tutorial 👇
-
-1. Download and Unzip the Courier Notification Service Extension: [`CourierNotificationServiceTemplate.zip`](https://github.com/trycourier/courier-notification-service-extension-template/archive/refs/heads/main.zip)
-2. Open the folder in terminal and run `sh make_template.sh`
-   - This will create the Notification Service Extension on your mac to save you time
-3. Open your iOS app in Xcode and go to File > New > Target
-4. Select "Courier Service" and click "Next"
-5. Give the Notification Service Extension a name (i.e. "CourierService"), select `Courier_iOS` as the Package, and click "Finish"
-6. Click "Cancel" on the next popup
-   - You do NOT need to click "Activate" here. Your Notification Service Extension will still work just fine.
-7. Open your `Podfile` and add the following snippet to the end of your Podfile
-   - This will link the `Courier-iOS` pod to your Notification Service Extension
-
-```
-target 'CourierService' do
-  pod 'Courier-iOS'
-end
-```
-
-8. From the root of your React Native app, run: `cd ios && pod install`
-
-&emsp;
-
-## **3. Android Setup**
-
-> If you don't need push notification support on Android, you can skip this step.
-
-https://user-images.githubusercontent.com/6370613/199335432-aa52028a-f7ae-48bb-abec-427795baa6f4.mov
-
-### Written Tutorial 👇
-
-1. Open Android project
-2. Register your app in Firebase and download your `google-services.json` file
-3. Add the `google-services.json` file to your `yourApp/app/src` directory
-4. Make sure your `yourApp/android/build.gradle` file supports Jitpack:
-
-```groovy
-allprojects {
-    repositories {
-        ..
-        maven { url 'https://www.jitpack.io' } // This line is needed
-    }
-}
-```
-
-3. Update your `yourApp/android/build.gradle` to support the following SDK versions
-    - This is needed to support newer Android Notification APIs
-
-```groovy
-buildscript {
-    ext {
-        buildToolsVersion = "32.0.0"
-        minSdkVersion = 21
-        compileSdkVersion = 32
-        targetSdkVersion = 32
-        ..
-    }
-    ..
-}
-```
-
-4. Add the `google-services` dependency to your `yourApp/android/build.gradle` file: 
-
-```groovy
-buildscript {
-  dependencies {
-    ..
-    classpath("com.google.gms:google-services:4.3.14") // Add this line
-  }
-}
-```
-
-5. Add this following line to the top of your `/android/app/build.gradle` file:
-
-```groovy
-apply plugin: "com.android.application"
-apply plugin: "com.google.gms.google-services" // Add this line
-```
-
-6. Run Gradle Sync
-
-### **Update Activity and Register Service**
-
-https://user-images.githubusercontent.com/6370613/199335233-0880209b-5aec-4584-9726-eaa1077bf80d.mov
-
-### Written Tutorial 👇
-
-1. Change your `MainActivity` to extend the `CourierReactNativeActivity`
-   - This allows Courier to handle when push notifications are delivered and clicked
-2. Setup a new Notification Service by creating a new java file and paste the code below in it
-   - This allows you to present a notification to your user when a new notification arrives and will automatically sync new fcm tokens to Courier token management
-
-```java
-// Your project import
-
-import android.annotation.SuppressLint;
-import androidx.annotation.NonNull;
-import com.courier.android.notifications.RemoteMessageExtensionsKt;
-import com.courier.android.service.CourierService;
-import com.google.firebase.messaging.RemoteMessage;
-
-// This is safe. `CourierService` will automatically handle token refreshes.
-@SuppressLint("MissingFirebaseInstanceTokenRefresh")
-public class YourExampleService extends CourierService {
-    
-    @Override
-    public void showNotification(@NonNull RemoteMessage message) {
-        super.showNotification(message);
-
-        // TODO: This is where you will customize the notification that is shown to your users
-        // The function below is used to get started quickly.
-        // You likely do not want to use `message.presentNotification(...)`
-        // For React Native, you likely do not want to change RemoteMessageExtensionsKt.presentNotification.handlingClass
-        // More information on how to customize an Android notification here:
-        // https://developer.android.com/develop/ui/views/notifications/build-notification
-
-        RemoteMessageExtensionsKt.presentNotification(
-                message,
-                this,
-                MainActivity.class,
-                android.R.drawable.ic_dialog_info,
-                "Notification Service"
-        );
-
-    }
-    
-}
-```
-
-3. Add the Notification Service entry in your `AndroidManifest.xml` file
-
-```xml
-<manifest>
-    <application>
-
-        <activity>
-            ..
-        </activity>
-
-        // Add this 👇
-        <service
-            android:name=".YourExampleService"
-            android:exported="false">
-            <intent-filter>
-                <action android:name="com.google.firebase.MESSAGING_EVENT" />
-            </intent-filter>
-        </service>
-        // Add this 👆
-
-        ..
-
-    </application>
-</manifest>
-```
-
-&emsp;
-
-## **4. Configure Push Provider**
-
-> If you don't need push notification support, you can skip this step.
-
-To get push notification to appear in your app, add support for the provider you would like to use:
-
-- [`APNS (Apple Push Notification Service)`](https://app.courier.com/channels/apn)
-- [`FCM (Firebase Cloud Messaging)`](https://app.courier.com/channels/firebase-fcm)
-
-&emsp;
-
-## **5. Managing User State**
-
-Best user experience practice is to synchronize the current user's push notification tokens and the user's state. Courier does most of this for you automatically!
-
-> You can use a Courier Auth Key [`found here`](https://app.courier.com/settings/api-keys) when developing.
-
-> When you are ready for production release, you should be using a JWT as the `accessToken`.
-> Here is more info about [`Going to Production`](#going-to-production)
-
-Place these functions where you normally manage your user's state:
-
-```dart
-// Saves accessToken and userId to native level local storage
-// This will persist between app sessions
-await Courier.signIn({
-  accessToken: accessToken,
-  userId: userId,
-});
-
-await Courier.signOut();
+```sh
+npm install courier-react-native
 ```
 
-If you followed the steps above:
-
-- APNS tokens on iOS will automatically be synced to Courier
-- FCM tokens on Android will automatically be synced to Courier
-
-<!-- If you want FCM tokens to sync to Courier on iOS:
-
-1. Add the following react native packages to your project
-   - [`React Native Firebase`](https://rnfirebase.io/)
-
-2. Add code to manually sync FCM tokens
-
-```typescript
-const fcmToken = await FirebaseMessaging.instance.getToken();
-if (fcmToken != null) {
-    await Courier.shared.setFcmToken(token: fcmToken);
-}
-
-// Handle FCM token refreshes
-FirebaseMessaging.instance.onTokenRefresh.listen((fcmToken) {
-    Courier.shared.setFcmToken(token: fcmToken);
-});
-``` -->
-
-&emsp;
-
-## **6. Testing Push Notifications**
-
-> If you don't need push notification support, you can skip this step.
-
-Courier allows you to send a push notification directly from the SDK to a user id. No tokens juggling or backend needed!
-
-```typescript
-const notificationPermission = await Courier.notificationPermissionStatus;
-console.log(notificationPermission);
-
-// Notification permissions must be `authorized` on iOS to receive pushes
-
-const requestedNotificationPermission = await Courier.requestNotificationPermission();
-console.log(requestedNotificationPermission);
-
-// This is how iOS will show the notification when the app is in the foreground
-// Passing [] will not present anything
-// `onPushNotificationDelivered` will still get called
-await Courier.iOSForegroundPresentationOptions({
-  options: ['badge', 'banner', 'list', 'sound'],
-});
-
-
-// This function returns an unsubscribe function
-// Call `unsibscribe();` to stop listening to notifications
-// Recommended to call the function while component mounts and unsubscribe when the component unmounts
-const unsubscribe = Courier.registerPushNotificationListeners({
-
-  // Will be called if the app is in the foreground and a push notification arrives
-  onPushNotificationClicked(push) {
-    console.log(push.title)
-  },
-
-  // Will be called when a user clicks a push notification
-  onPushNotificationDelivered(push) {
-    console.log(push.title)
-  }
-  
-});
-
-// Sends a test push
-const messageId = await Courier.sendPush({
-  authKey: 'your_courier_auth_key_that_should_only_be_used_for_testing',
-  userId: 'example_user',
-  title: 'Chirp Chrip!',
-  body: 'Hello from Courier 🐣',
-  isProduction: false, // This only affects APNS pushes. false == sandbox / true == production
-  providers: [CourierProvider.APNS, CourierProvider.FCM],
-});
-```
-
-&emsp;
-
-## **Going to Production**
+## Usage
 
-For security reasons, you should not keep your `authKey` (which looks like: `pk_prod_ABCD...`) in your production app. The `authKey` is safe to test with, but you will want to use an `accessToken` in production.
+```js
+import { CourierReactNativeView } from "courier-react-native";
 
-To create an `accessToken`, call this:
+// ...
 
-```curl
-curl --request POST \
-     --url https://api.courier.com/auth/issue-token \
-     --header 'Accept: application/json' \
-     --header 'Authorization: Bearer $YOUR_AUTH_KEY' \
-     --header 'Content-Type: application/json' \
-     --data
- '{
-    "scope": "user_id:$YOUR_USER_ID write:user-tokens",
-    "expires_in": "$YOUR_NUMBER days"
-  }'
+<CourierReactNativeView color="tomato" />
 ```
 
-Or generate one here: [`Issue Courier Access Token`](https://www.courier.com/docs/reference/auth/issue-token/)
+## Contributing
 
-> This request to issue a token should likely exist in a separate endpoint served on your backend.
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
 
-&emsp;
+## License
 
-## **Share feedback with Courier**
+MIT
 
-We want to make this the best SDK for managing notifications! Have an idea or feedback about our SDKs? Here are some links to contact us:
+---
 
-- [Courier Feedback](https://feedback.courier.com/)
-- [Courier React Native Issues](https://github.com/trycourier/courier-react-native/issues)
+Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

package/android/build.gradle

@@ -1,44 +1,70 @@
 buildscript {
   // Buildscript is evaluated before everything else so we can't use getExtOrDefault
-  def kotlin_version = rootProject.ext.has('kotlinVersion') ? rootProject.ext.get('kotlinVersion') : project.properties['CourierReactNative_kotlinVersion']
+  def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["CourierReactNative_kotlinVersion"]
 
   repositories {
-      google()
-      mavenCentral()
+    google()
+    mavenCentral()
   }
 
   dependencies {
-    classpath 'com.android.tools.build:gradle:3.5.3'
+    classpath "com.android.tools.build:gradle:7.2.1"
     // noinspection DifferentKotlinGradleVersion
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }
 }
 
 def isNewArchitectureEnabled() {
-  return rootProject.hasProperty("newArchEnabled") &&  rootProject.getProperty("newArchEnabled") == "true"
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
 }
 
-apply plugin: 'com.android.library'
-apply plugin: 'kotlin-android'
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+
+def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
 
 if (isNewArchitectureEnabled()) {
-  apply plugin: 'com.facebook.react'
+  apply plugin: "com.facebook.react"
 }
 
 def getExtOrDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['CourierReactNative_' + name]
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["CourierReactNative_" + name]
 }
 
 def getExtOrIntegerDefault(name) {
-  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['CourierReactNative_' + name]).toInteger()
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["CourierReactNative_" + name]).toInteger()
+}
+
+def supportsNamespace() {
+  def parsed = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize('.')
+  def major = parsed[0].toInteger()
+  def minor = parsed[1].toInteger()
+
+  // Namespace support was added in 7.3.0
+  if (major == 7 && minor >= 3) {
+    return true
+  }
+
+  return major >= 8
 }
 
 android {
-  compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')
+  if (supportsNamespace()) {
+    namespace "com.courierreactnative"
+
+    sourceSets {
+      main {
+        manifest.srcFile "src/main/AndroidManifestNew.xml"
+      }
+    }
+  }
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
 
   defaultConfig {
-    minSdkVersion getExtOrIntegerDefault('minSdkVersion')
-    targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
     buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
   }
   buildTypes {
@@ -48,102 +74,41 @@ android {
   }
 
   lintOptions {
-    disable 'GradleCompatible'
+    disable "GradleCompatible"
   }
 
   compileOptions {
     sourceCompatibility JavaVersion.VERSION_1_8
     targetCompatibility JavaVersion.VERSION_1_8
   }
+
 }
 
 repositories {
   mavenCentral()
   google()
   maven { url 'https://jitpack.io' }
-
-  def found = false
-  def defaultDir = null
-  def androidSourcesName = 'React Native sources'
-
-  if (rootProject.ext.has('reactNativeAndroidRoot')) {
-    defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
-  } else {
-    defaultDir = new File(
-      projectDir,
-      '/../../../node_modules/react-native/android'
-    )
-  }
-
-  if (defaultDir.exists()) {
-    maven {
-      url defaultDir.toString()
-      name androidSourcesName
-    }
-
-    logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
-    found = true
-  } else {
-    def parentDir = rootProject.projectDir
-
-    1.upto(5, {
-      if (found) return true
-      parentDir = parentDir.parentFile
-
-      def androidSourcesDir = new File(
-        parentDir,
-        'node_modules/react-native'
-      )
-
-      def androidPrebuiltBinaryDir = new File(
-        parentDir,
-        'node_modules/react-native/android'
-      )
-
-      if (androidPrebuiltBinaryDir.exists()) {
-        maven {
-          url androidPrebuiltBinaryDir.toString()
-          name androidSourcesName
-        }
-
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
-        found = true
-      } else if (androidSourcesDir.exists()) {
-        maven {
-          url androidSourcesDir.toString()
-          name androidSourcesName
-        }
-
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
-        found = true
-      }
-    })
-  }
-
-  if (!found) {
-    throw new GradleException(
-      "${project.name}: unable to locate React Native android sources. " +
-      "Ensure you have you installed React Native as a dependency in your project and try again."
-    )
-  }
 }
 
-def kotlin_version = getExtOrDefault('kotlinVersion')
+def kotlin_version = getExtOrDefault("kotlinVersion")
 
 dependencies {
-    //noinspection GradleDynamicVersion
+
+  // For < 0.71, this will be from the local maven repo
+  // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
+  //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   // Courier Core SDK
-  api 'com.github.trycourier:courier-android:1.1.1'
+  api 'com.github.trycourier:courier-android:2.0.2'
 
 }
 
 if (isNewArchitectureEnabled()) {
   react {
     jsRootDir = file("../src/")
-    libraryName = "CourierReactNative"
+    libraryName = "CourierReactNativeView"
     codegenJavaPackageName = "com.courierreactnative"
   }
 }

package/android/src/main/AndroidManifest.xml

@@ -1,4 +1,3 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
           package="com.courierreactnative">
-
 </manifest>

package/android/src/main/AndroidManifestNew.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>