Merge branch 'main' into MOB-11360-remove-apikey

Author: lposen

README.md

@@ -24,7 +24,9 @@ the native code is generated through `expo prebuild`.
 - [Troubleshooting](#troubleshooting)
   - [Native Module Not Found](#native-module-not-found)
   - [Failed to delete [ios|android] code: ENOTEMPTY: directory not empty](#failed-to-delete-iosandroid-code-enotempty-directory-not-empty)
+- [Contributing](#contributing)
 - [License](#license)
+- [Support](#support)
 - [Further Reading](#further-reading)
 
 <!-- /code_chunk_output -->
@@ -86,7 +88,6 @@ Add the plugin to your `app.json` or `app.config.js`:
         "autoConfigurePushNotifications": true,
         "enableTimeSensitivePush": true,
         "requestPermissionsForPushNotifications": true,
-        "enableInAppMessages": true
       }]
     ]
   }
@@ -97,12 +98,11 @@ Add the plugin to your `app.json` or `app.config.js`:
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `apiKey` | string | - | Your Iterable API key |
-| `appEnvironment` | 'development' \| 'production' | 'development' | The environment for your app |
-| `autoConfigurePushNotifications` | boolean | true | Whether to automatically configure push notifications |
-| `enableTimeSensitivePush` | boolean | true | Whether to enable time-sensitive push notifications (ios only) |
-| `requestPermissionsForPushNotifications` | boolean | true | Whether to request permissions for push notifications (ios only) |
-| `enableInAppMessages` | boolean | true | Whether to enable in-app messages |
+| `apiKey` | string | `''` | Your Iterable project API key |
+| `appEnvironment` | `'development'` \| `'production'` | `'development'` | The environment of your app |
+| `autoConfigurePushNotifications` | boolean | `true` | Whether to automatically configure push notifications. Set to `false` if you want to configure push notifications manually.  <br><br> **WARNING**: Iterable cannot guarantee compatibility with custom push notification configurations. |
+| `enableTimeSensitivePush` | boolean | `true` | Whether to enable time-sensitive push notifications (iOS only) |
+| `requestPermissionsForPushNotifications` | boolean | `false` | Whether to request permissions for push notifications (iOS only) |
 
 ### Disabling New Architecture
 `@iterable/react-native-sdk` is *NOT* compatible with Reacts New Architecture,
@@ -118,7 +118,7 @@ so this needs to be disabled in your `app.json`:
 
 ### Adding push capabilities to android
 
-Add the path to your google-services.json file to the app file under
+Add the path to your google-services.json file to the app.json file under
 `expo.android.googleServicesFile`.  EG: If the google services file was added to
 the root of the app, the expo file would look like this:
 ```json
@@ -315,9 +315,21 @@ Sometimes this error appears when running `npx expo prebuild --clean`.  It seems
 to be an intermittent bug within expo.  It usually works upon running the same
 command a second time, so just try again.
 
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
 ## License
 
-MIT
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
+for details.
+
+## Support
+
+For support, please:
+1. Check the [documentation](https://github.com/Iterable/iterable-expo-plugin#readme)
+2. Open an [issue](https://github.com/Iterable/iterable-expo-plugin/issues)
+3. Contact [Iterable support](https://support.iterable.com/hc/en-us/requests/new)
 
 ## Further Reading
 - [Installing Iterables React Native

example/app.json

@@ -69,7 +69,6 @@
         {
           "appEnvironment": "development",
           "autoConfigurePushNotifications": true,
-          "enableInAppMessages": true,
           "enableTimeSensitivePush": true,
           "requestPermissionsForPushNotifications": true
         }

ios/ExpoAdapterIterable/IterableAppDelegate.swift

@@ -35,14 +35,10 @@ public class IterableAppDelegate: ExpoAppDelegateSubscriber, UIApplicationDelega
     fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void
   ) {
 
-    if Bundle.main.object(
-      forInfoDictionaryKey: "ITERABLE_ENABLE_IN_APP_MESSAGES") as? Bool == true
-    {
-      IterableAppIntegration.application(
-        application, didReceiveRemoteNotification: userInfo,
-        fetchCompletionHandler: completionHandler
-      )
-    }
+    IterableAppIntegration.application(
+      application, didReceiveRemoteNotification: userInfo,
+      fetchCompletionHandler: completionHandler
+    )
   }
 
   public func application(

plugin/src/index.ts

@@ -18,7 +18,6 @@ const withIterable: ConfigPlugin<ConfigPluginProps> = (config, props = {}) => {
     enableTimeSensitivePush: props.enableTimeSensitivePush ?? true,
     requestPermissionsForPushNotifications:
       props.requestPermissionsForPushNotifications ?? false,
-    enableInAppMessages: props.enableInAppMessages ?? true,
   };
 
   return withPlugins(config, [

plugin/src/withIterable.types.ts

@@ -6,24 +6,31 @@ export interface ConfigPluginProps {
   appEnvironment?: 'development' | 'production';
   /**
    * Whether to automatically configure push notifications.
+   *
+   * If true, this will set up the necessary permissions and configurations for
+   * push notifications according to the Iterable SDK documentation.  If you
+   * would like to build your own push notification configuration, set this to
+   * false -- but do so with caution as Iterable cannot guarantee compatibility
+   * with custom push notification configurations.
    * @default true
    */
   autoConfigurePushNotifications?: boolean;
   /**
    * Whether to enable time-sensitive push notifications.
+   *
+   * (iOS only)
+   *
    * @default true
    */
   enableTimeSensitivePush?: boolean;
   /**
    * Whether to request permissions for push notifications.
+   *
+   * (iOS only)
+   *
    * @default false
    */
   requestPermissionsForPushNotifications?: boolean;
-  /**
-   * Whether to enable in-app messages.
-   * @default true
-   */
-  enableInAppMessages?: boolean;
 }
 
 export type ConfigPluginPropsWithDefaults = Required<ConfigPluginProps>;

plugin/src/withPushNotifications/index.ts

@@ -7,6 +7,14 @@ import { withIosPushNotifications } from './withIosPushNotifications';
 export const withPushNotifications: ConfigPlugin<
   ConfigPluginPropsWithDefaults
 > = (config, props) => {
+  /**
+   * No need to do anything if `props.autoConfigurePushNotifications` is
+   * explicitly set to `false`.
+   */
+  if (props.autoConfigurePushNotifications === false) {
+    return config;
+  }
+
   return withPlugins(config, [
     [withIosPushNotifications, props],
     [withAndroidPushNotifications, props],

plugin/src/withPushNotifications/withAndroidPushNotifications.ts

@@ -1,6 +1,7 @@
 import {
   ConfigPlugin,
   WarningAggregator,
+  withAndroidManifest,
   withAppBuildGradle,
   withDangerousMod,
   withPlugins,
@@ -166,6 +167,33 @@ const withFirebase: ConfigPlugin<ConfigPluginPropsWithDefaults> = (
   ]);
 };
 
+/**
+ * Add the POST_NOTIFICATIONS permission to the AndroidManifest.xml file if it
+ * doesn't exist.
+ */
+const withAppPermissions: ConfigPlugin<ConfigPluginPropsWithDefaults> = (
+  config
+) => {
+  return withAndroidManifest(config, (newConfig) => {
+    const androidManifest = newConfig.modResults.manifest;
+    if (!androidManifest['uses-permission']) {
+      androidManifest['uses-permission'] = [];
+    }
+    const postPermission = 'android.permission.POST_NOTIFICATIONS';
+    const currPostPermission = androidManifest['uses-permission'].find(
+      (p) => p.$['android:name'] === postPermission
+    );
+
+    // Only add the permission if it doesn't exist
+    if (!currPostPermission) {
+      androidManifest['uses-permission'].push({
+        $: { 'android:name': postPermission },
+      });
+    }
+    return newConfig;
+  });
+};
+
 /**
  * Copy `google-services.json`
  * TODO: Add this step to the docs
@@ -212,6 +240,7 @@ export const withAndroidPushNotifications: ConfigPlugin<
     return config;
   }
   return withPlugins(config, [
+    [withAppPermissions, props],
     [withFirebase, props],
     [withCopyAndroidGoogleServices, props],
   ]);

plugin/src/withPushNotifications/withIosPushNotifications.ts

@@ -294,14 +294,6 @@ end`;
 export const withIosPushNotifications: ConfigPlugin<
   ConfigPluginPropsWithDefaults
 > = (config, props) => {
-  /**
-   * No need to do anything if `props.autoConfigurePushNotifications` is
-   * explicitly set to `false`.
-   */
-  if (props.autoConfigurePushNotifications === false) {
-    return config;
-  }
-
   return withPlugins(config, [
     [withCapabilities, props],
     [withBackgroundModes, props],

plugin/src/withStoreConfigValues.ts

@@ -15,7 +15,7 @@ import { type ConfigPluginPropsWithDefaults } from './withIterable.types';
  */
 type JsKey = keyof Pick<
   ConfigPluginPropsWithDefaults,
-  'requestPermissionsForPushNotifications' | 'enableInAppMessages'
+  'requestPermissionsForPushNotifications'
 >;
 
 /**
@@ -34,7 +34,6 @@ type NativeKey = string;
 const nativeKeyMap: Record<JsKey, NativeKey> = {
   requestPermissionsForPushNotifications:
     'ITERABLE_REQUEST_PERMISSIONS_FOR_PUSH_NOTIFICATIONS',
-  enableInAppMessages: 'ITERABLE_ENABLE_IN_APP_MESSAGES',
 };
 
 const withStoreValuesOnIos: ConfigPlugin<ConfigPluginPropsWithDefaults> = (

plugin/tsconfig.tsbuildinfo

@@ -1,15 +1 @@
-{
-  "root": [
-    "./src/index.ts",
-    "./src/withdeeplinks.ts",
-    "./src/withiterable.types.ts",
-    "./src/withiterableapis.ts",
-    "./src/withstoreconfigvalues.ts",
-    "./src/withpushnotifications/index.ts",
-    "./src/withpushnotifications/withandroidpushnotifications.constants.ts",
-    "./src/withpushnotifications/withandroidpushnotifications.ts",
-    "./src/withpushnotifications/withiospushnotifications.constants.ts",
-    "./src/withpushnotifications/withiospushnotifications.ts"
-  ],
-  "version": "5.8.3"
-}
+{"root":["./src/index.ts","./src/withdeeplinks.ts","./src/withiterable.types.ts","./src/withstoreconfigvalues.ts","./src/withpushnotifications/index.ts","./src/withpushnotifications/withandroidpushnotifications.constants.ts","./src/withpushnotifications/withandroidpushnotifications.ts","./src/withpushnotifications/withiospushnotifications.constants.ts","./src/withpushnotifications/withiospushnotifications.ts"],"version":"5.8.3"}