Merge pull request #24 from Iterable/MOB-11359-remove-unnecessary-configs

[MOB-11359] remove-unnecessary-configs

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,
@@ -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

@@ -26,7 +26,6 @@
         "backgroundColor": "#ffffff"
       },
       "package": "expo.modules.adapters.iterable.example",
-      "googleServicesFile": "./google-services.json",
       "intentFilters": [
         {
           "action": "MAIN",
@@ -71,7 +70,6 @@
           "apiKey": "YOUR_ITERABLE_API_KEY",
           "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

@@ -19,7 +19,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

@@ -10,24 +10,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/withStoreConfigValues.ts

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