Merge branch 'main' into task/update-types

Author: jasonpraful

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 # Default VM config to be used for macOS builds
 macos_config: &macos_config
   macos:
-    xcode: 15.3.0
+    xcode: 16.0.0
   resource_class: macos.m1.large.gen1
   shell: /bin/bash --login -eo pipefail
 
@@ -20,7 +20,8 @@ executors:
     working_directory: ~/project
 
 orbs:
-  android: circleci/android@1.0
+  android: circleci/android@2.4.0
+  node: circleci/node@5.1.0
 
 # Always run job
 run_always: &run_always
@@ -54,18 +55,14 @@ jobs:
           name: Install dependencies
           command: |
             corepack enable
-            yarn install --cwd example
-            yarn install --cwd example/e2e
-            yarn install
+            yarn install --cwd example --ignore-engines
+            yarn install --ignore-engines
       - save_cache:
           key: dependencies-{{ checksum "package.json" }}
           paths: node_modules
       - save_cache:
           key: dependencies-example-{{ checksum "example/package.json" }}
           paths: example/node_modules
-      - save_cache:
-          key: dependencies-example-e2e-{{ checksum "example/package.json" }}
-          paths: example/e2e/node_modules
       - persist_to_workspace:
           root: .
           paths: .
@@ -115,18 +112,25 @@ jobs:
       JAVA_OPTS: '-Xms512m -Xmx1024m'
     executor:
       name: android/android-machine
+      tag: default
     working_directory: ~/project
     steps:
       - checkout:
           path: ~/project
+      - node/install:
+          node-version: 18.17.0
 
       - attach_workspace:
           at: ~/project
 
       - <<: *setup_env_file
 
       - run:
-          working_directory: example/e2e
+          name: Install Maestro
+          command: curl -Ls "https://get.maestro.mobile.dev" | bash
+
+      - run:
+          working_directory: example/test
           name: Build android
           command: npm run build:android
 
@@ -141,10 +145,19 @@ jobs:
           post-emulator-launch-assemble-command: echo Emulator Started
 
       - run:
-          working_directory: example/e2e
+          name: Install app on emulator
+          command: |
+            adb install -r ~/project/example/android/app/build/outputs/apk/release/app-release.apk
+
+      - run:
+          working_directory: example/test
           name: Run UI Tests
           command: npm run test:android
 
+      - store_artifacts:
+          path: ~/.maestro/tests
+          destination: maestro-tests
+
   # Build the Test App used for UI Testing and save is to the workspace. This allows it to be used by other jobs.
   ios-e2e-test:
     <<: *macos_config
@@ -155,28 +168,49 @@ jobs:
 
       - <<: *setup_env_file
 
+      - run:
+          working_directory: example/e2e
+          name: Install Maestro
+          command: curl -Ls "https://get.maestro.mobile.dev" | bash
+
       - restore_cache:
           keys:
             - pod-dependencies-{{ checksum "~/project/example/ios/Podfile" }}
       - run:
           working_directory: example/ios
           name: Install Pods
           command: pod install
+
       - save_cache:
           key: pod-dependencies-{{ checksum "~/project/example/ios/Podfile" }}
           paths:
             - ~/project/example/ios/Pods
 
       - run:
-          working_directory: example/e2e
+          working_directory: example/test
           name: Build
           command: npm run build:ios
 
       - run:
-          working_directory: example/e2e
+          name: Create and boot iPhone 15 simulator
+          command: |
+            echo "Creating iPhone 15 simulator with runtime $RUNTIME"
+            xcrun simctl create "iPhone 15" com.apple.CoreSimulator.SimDeviceType.iPhone-15 $RUNTIME
+            xcrun simctl boot "iPhone 15" || true
+
+      - run:
+          name: Install app on simulator
+          command: |
+            xcrun simctl install booted ~/project/example/test/build/Build/Products/Release-iphonesimulator/IntercomReactNativeExampleUI.app
+
+      - run:
+          working_directory: example/test
           name: Run UI Tests
           command: npm run test:ios
 
+      - store_artifacts:
+          path: ~/.maestro/tests
+          destination: maestro-tests
 
   release-to-npm:
     executor: default
@@ -195,7 +229,7 @@ jobs:
       - run:
           name: Install dependencies
           command: |
-            yarn install
+            yarn install --ignore-engines
 
       - run:
           name: Publish the package
@@ -224,6 +258,7 @@ workflows:
           <<: *run_always
           requires:
             - install-dependencies
+      # Temporarily disabled Maestro e2e tests
       # - android-e2e-test:
       #     <<: *run_always
       #     requires:
@@ -240,6 +275,7 @@ workflows:
       #       - typescript
       #       - unit-tests
       #       - build-package
+
       - release-to-npm:
           <<: *run_on_release
           context:
@@ -250,5 +286,6 @@ workflows:
             - typescript
             - unit-tests
             - build-package
+            # Temporarily removed e2e test dependencies
             # - ios-e2e-test
             # - android-e2e-test

.gitignore

@@ -46,6 +46,8 @@ node_modules/
 npm-debug.log
 yarn-debug.log
 yarn-error.log
+yarn.lock
+package-lock.json
 
 # BUCK
 buck-out/

.refactorer/config.md

@@ -0,0 +1,11 @@
+## Checks
+
+### yarn lint
+
+`yarn lint` failed with the following output:
+
+<output>
+{output}
+</output>
+
+Your task is to understand and fix all linting errors. Do run `yarn lint` again when you're done to be sure that everything is fixed.

README.md

@@ -173,31 +173,61 @@ apply from: file("../../node_modules/@react-native-community/cli-platform-androi
 - Create `MainNotificationService.java` inside your app directory(`com.example.app`) with below content:
 
   ***Remember to replace `package com.example.app;`, with your app package name***
+  - Default Notification Behavior (Goes back to the parent default launcher activity when the user taps the notification):
 
-```java
-package com.example.app;
+    ```java
+    package com.example.app;
 
-import com.google.firebase.messaging.FirebaseMessagingService;
-import com.google.firebase.messaging.RemoteMessage;
-import com.intercom.reactnative.IntercomModule;
+    import com.google.firebase.messaging.FirebaseMessagingService;
+    import com.google.firebase.messaging.RemoteMessage;
+    import com.intercom.reactnative.IntercomModule;
 
-public class MainNotificationService extends FirebaseMessagingService {
+    public class MainNotificationService extends FirebaseMessagingService {
 
-  @Override
-  public void onNewToken(String refreshedToken) {
-    IntercomModule.sendTokenToIntercom(getApplication(), refreshedToken);
-    //DO LOGIC HERE
-  }
+      @Override
+      public void onNewToken(String refreshedToken) {
+        IntercomModule.sendTokenToIntercom(getApplication(), refreshedToken);
+        //DO LOGIC HERE
+      }
 
-  public void onMessageReceived(RemoteMessage remoteMessage) {
-    if (IntercomModule.isIntercomPush(remoteMessage)) {
-      IntercomModule.handleRemotePushMessage(getApplication(), remoteMessage);
-    } else {
-      // HANDLE NON-INTERCOM MESSAGE
+      public void onMessageReceived(RemoteMessage remoteMessage) {
+        if (IntercomModule.isIntercomPush(remoteMessage)) {
+          IntercomModule.handleRemotePushMessage(getApplication(), remoteMessage);
+        } else {
+          // HANDLE NON-INTERCOM MESSAGE
+        }
+      }
     }
-  }
-}
-```
+    ```
+
+  - Custom Stack:
+
+    ```java
+    package com.example.app;
+
+    import com.google.firebase.messaging.FirebaseMessagingService;
+    import com.google.firebase.messaging.RemoteMessage;
+    import com.intercom.reactnative.IntercomModule;
+
+    public class MainNotificationService extends FirebaseMessagingService {
+
+      @Override
+      public void onNewToken(String refreshedToken) {
+        IntercomModule.sendTokenToIntercom(getApplication(), refreshedToken);
+        //DO LOGIC HERE
+      }
+
+      public void onMessageReceived(RemoteMessage remoteMessage) {
+        if (IntercomModule.isIntercomPush(remoteMessage)) {
+          TaskStackBuilder customStack = TaskStackBuilder.create(getApplication());
+          customStack.addNextIntent(new Intent(getApplication(), MainActivity.class)); // Replace with your custom activity
+          IntercomModule.handleRemotePushWithCustomStack(getApplication(), remoteMessage, customStack);
+        } else {
+          // HANDLE NON-INTERCOM MESSAGE
+        }
+      }
+    }
+    ```
 
 - Edit `AndroidManifest.xml`. Add below content inside `<application>` below `<activity/>`
 
@@ -222,10 +252,6 @@ public class MainNotificationService extends FirebaseMessagingService {
       </intent-filter>
     </service>
 
-    <receiver
-      android:name="com.intercom.reactnative.RNIntercomPushBroadcastReceiver"
-      tools:replace="android:exported"
-      android:exported="true"/>
     <!-- END: Add this-->
 
   </application>
@@ -1092,6 +1118,27 @@ ___
 
 ___
 
+### `Intercom.setUserJwt(JWT)`
+
+Sets a JWT token for the user, necessary for using the Messenger when Messenger Security is enforced. This is an
+improvement to Identity Verification.
+
+Secure your Messenger to make sure that bad actors can't impersonate your users, see their conversation history or make
+unauthorized updates to data.
+
+This should be called before any user login takes place.
+
+### Options
+
+| Type | Type   | Required |
+|------|--------|----------|
+| JWT  | string | yes      |
+
+### Returns
+
+`Promise<boolean>`
+___
+
 ## Author
 
 👤 **Intercom (https://www.intercom.com/)**