customerio-expo-plugin 1.0.0-beta.1 → 1.0.0-beta.10

package/src/android/withCIOAndroid.ts

@@ -1,6 +1,7 @@
 import type { ExpoConfig } from '@expo/config-types';
 
 import type { CustomerIOPluginOptionsAndroid } from '../types/cio-types';
+import { withAndroidManifestUpdates } from './withAndroidManifestUpdates';
 import { withAppGoogleServices } from './withAppGoogleServices';
 import { withGistMavenRepository } from './withGistMavenRepository';
 import { withGoogleServicesJSON } from './withGoogleServicesJSON';
@@ -14,6 +15,9 @@ export function withCIOAndroid(
   config = withProjectGoogleServices(config, props);
   config = withAppGoogleServices(config, props);
   config = withGoogleServicesJSON(config, props);
+  if (props.setHighPriorityPushHandler) {
+    config = withAndroidManifestUpdates(config, props);
+  }
 
   return config;
 }

package/src/helpers/constants/ios.ts

@@ -1,6 +1,17 @@
-export const LOCAL_PATH_TO_CIO_NSE_FILES = `node_modules/customerio-expo-plugin/src/helpers/native-files/ios`;
+const finder = require('find-package-json');
+const path = require('path');
+
+const f = finder(__dirname);
+let pluginPackageRoot = f.next().filename;
+// This is the path to the root of the customerio-expo-plugin package
+pluginPackageRoot = path.dirname(pluginPackageRoot);
+
+export const LOCAL_PATH_TO_CIO_NSE_FILES = path.join(
+  pluginPackageRoot,
+  'src/helpers/native-files/ios'
+);
 export const IOS_DEPLOYMENT_TARGET = '13.0';
-export const CIO_SDK_VERSION = '~> 2.0.0';
+export const CIO_SDK_VERSION = "'~> 2.0'";
 export const CIO_PODFILE_REGEX = /pod 'CustomerIO\/MessagingPushAPN'/;
 export const CIO_CIO_TARGET_REGEX = /cio_target_names/;
 export const CIO_PODFILE_NOTIFICATION_REGEX = /target 'NotificationService' do/;
@@ -40,10 +51,12 @@ CIOAppPushNotificationsHandler* pnHandlerObj = [[CIOAppPushNotificationsHandler
 `;
 
 export const CIO_DIDFAILTOREGISTERFORREMOTENOTIFICATIONSWITHERROR_SNIPPET = `
+  [super application:application didFailToRegisterForRemoteNotificationsWithError:error];
   [pnHandlerObj application:application error:error];
 `;
 
 export const CIO_DIDREGISTERFORREMOTENOTIFICATIONSWITHDEVICETOKEN_SNIPPET = `
+  [super application:application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
   return [pnHandlerObj application:application deviceToken:deviceToken];
 `;
 
@@ -64,7 +77,7 @@ export const CIO_WILLPRESENTNOTIFICATIONHANDLER_SNIPPET = `
 - (void)userNotificationCenter:(UNUserNotificationCenter* )center willPresentNotification:(UNNotification* )notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler {
   completionHandler( UNNotificationPresentationOptionAlert + UNNotificationPresentationOptionSound);
 }`;
-export const CIO_PODFILE_SNIPPET = `  pod 'CustomerIO/MessagingPushAPN', '${CIO_SDK_VERSION}'`;
+export const CIO_PODFILE_SNIPPET = `  pod 'CustomerIO/MessagingPushAPN', ${CIO_SDK_VERSION}`;
 export const CIO_PODFILE_NOTIFICATION_SNIPPET = `
 target '${CIO_NOTIFICATION_TARGET_NAME}' do
 ${CIO_PODFILE_SNIPPET}
@@ -74,3 +87,18 @@ target '${CIO_NOTIFICATION_TARGET_NAME}' do
   use_frameworks! :linkage => :static
 ${CIO_PODFILE_SNIPPET}
 end`;
+
+export const CIO_REGISTER_PUSHNOTIFICATION_SNIPPET = `
+@objc(registerPushNotification:)
+  public func registerPushNotification(withNotificationDelegate notificationDelegate: UNUserNotificationCenterDelegate) {
+
+    let center  = UNUserNotificationCenter.current()
+    center.delegate = notificationDelegate
+    center.requestAuthorization(options: [.sound, .alert, .badge]) { (granted, error) in
+      if error == nil{
+        DispatchQueue.main.async {
+          UIApplication.shared.registerForRemoteNotifications()
+        }
+      }
+    }
+  }`;

package/src/helpers/native-files/ios/PushService.swift

@@ -9,19 +9,7 @@ public class CIOAppPushNotificationsHandler : NSObject {
 
   public override init() {}
 
-  @objc(registerPushNotification:)
-  public func registerPushNotification(withNotificationDelegate notificationDelegate: UNUserNotificationCenterDelegate) {
-
-    let center  = UNUserNotificationCenter.current()
-    center.delegate = notificationDelegate
-    center.requestAuthorization(options: [.sound, .alert, .badge]) { (granted, error) in
-      if error == nil{
-        DispatchQueue.main.async {
-          UIApplication.shared.registerForRemoteNotifications()
-        }
-      }
-    }
-  }
+  {{REGISTER_SNIPPET}}
 
   @objc(application:deviceToken:)
   public func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {

package/src/ios/withAppDelegateModifications.ts

@@ -22,6 +22,7 @@ import {
   injectCodeByMultiLineRegexAndReplaceLine,
 } from '../helpers/utils/codeInjection';
 import { FileManagement } from '../helpers/utils/fileManagement';
+import type { CustomerIOPluginOptionsIOS } from '../types/cio-types';
 
 const pushCodeSnippets = [
   CIO_DIDRECEIVENOTIFICATIONRESPONSEHANDLER_SNIPPET,
@@ -87,7 +88,7 @@ const addDidFailToRegisterForRemoteNotificationsWithError = (
   return stringContents;
 };
 
-const AddDidRegisterForRemoteNotificationsWithDeviceToken = (
+const addDidRegisterForRemoteNotificationsWithDeviceToken = (
   stringContents: string
 ) => {
   stringContents = injectCodeByMultiLineRegexAndReplaceLine(
@@ -119,9 +120,9 @@ const addAppdelegateHeaderModification = (stringContents: string) => {
   return stringContents;
 };
 
-export const withAppDelegateModifications: ConfigPlugin<any> = (
-  configOuter
-) => {
+export const withAppDelegateModifications: ConfigPlugin<
+  CustomerIOPluginOptionsIOS
+> = (configOuter, props) => {
   return withAppDelegate(configOuter, async (config) => {
     let stringContents = config.modResults.contents;
     const regex = new RegExp(
@@ -142,12 +143,19 @@ export const withAppDelegateModifications: ConfigPlugin<any> = (
         config.modRequest.projectName as string
       );
       stringContents = addNotificationHandlerDeclaration(stringContents);
-      stringContents = addNotificationConfiguration(stringContents);
+
+      // any other value would be treated as true, it has to be explicitly false to disable
+      if (
+        props.disableNotificationRegistration !== undefined &&
+        props.disableNotificationRegistration === false
+      ) {
+        stringContents = addNotificationConfiguration(stringContents);
+      }
       stringContents = addAdditionalMethodsForPushNotifications(stringContents);
       stringContents =
         addDidFailToRegisterForRemoteNotificationsWithError(stringContents);
       stringContents =
-        AddDidRegisterForRemoteNotificationsWithDeviceToken(stringContents);
+        addDidRegisterForRemoteNotificationsWithDeviceToken(stringContents);
 
       config.modResults.contents = stringContents;
     } else {

package/src/ios/withNotificationsXcodeProject.ts

@@ -1,8 +1,12 @@
-import { ConfigPlugin, withXcodeProject } from '@expo/config-plugins';
-import xcode from 'xcode';
+import {
+  ConfigPlugin,
+  XcodeProject,
+  withXcodeProject,
+} from '@expo/config-plugins';
 
 import {
   CIO_NOTIFICATION_TARGET_NAME,
+  CIO_REGISTER_PUSHNOTIFICATION_SNIPPET,
   DEFAULT_BUNDLE_VERSION,
   LOCAL_PATH_TO_CIO_NSE_FILES,
 } from '../helpers/constants/ios';
@@ -17,21 +21,10 @@ const ENV_FILENAME = 'Env.swift';
 const TARGETED_DEVICE_FAMILY = `"1,2"`;
 
 const addNotificationServiceExtension = async (
-  options: CustomerIOPluginOptionsIOS
+  options: CustomerIOPluginOptionsIOS,
+  xcodeProject: XcodeProject
 ) => {
-  // iosPath and appName are predefined from Expo config.
-  // See function withCioNotificationsXcodeProject to get where the variabes are pulled from.
-  const { iosPath, appName } = options;
-
-  const projPath = `${iosPath}/${appName}.xcodeproj/project.pbxproj`;
-
-  const xcodeProject = xcode.project(projPath);
-
-  xcodeProject.parse(async function (err: Error) {
-    if (err) {
-      throw new Error(`Error parsing iOS project: ${JSON.stringify(err)}`);
-    }
-
+  try {
     if (options.pushNotification) {
       await addPushNotificationFile(options, xcodeProject);
     }
@@ -39,9 +32,11 @@ const addNotificationServiceExtension = async (
     if (options.pushNotification?.useRichPush) {
       await addRichPushXcodeProj(options, xcodeProject);
     }
-
-    FileManagement.writeFile(projPath, xcodeProject.writeSync());
-  });
+    return xcodeProject;
+  } catch (error: any) {
+    console.error(error);
+    return null;
+  }
 };
 
 export const withCioNotificationsXcodeProject: ConfigPlugin<
@@ -84,6 +79,7 @@ export const withCioNotificationsXcodeProject: ConfigPlugin<
     }
 
     const options = {
+      ...props,
       appleTeamId,
       bundleIdentifier,
       bundleShortVersion,
@@ -95,7 +91,14 @@ export const withCioNotificationsXcodeProject: ConfigPlugin<
       pushNotification,
     };
 
-    await addNotificationServiceExtension(options);
+    const modifiedProjectFile = await addNotificationServiceExtension(
+      options,
+      config.modResults
+    );
+
+    if (modifiedProjectFile) {
+      config.modResults = modifiedProjectFile;
+    }
 
     return config;
   });
@@ -117,6 +120,15 @@ const addRichPushXcodeProj = async (
 
   await injectCIONotificationPodfileCode(iosPath, useFrameworks);
 
+  // Check if `CIO_NOTIFICATION_TARGET_NAME` group already exist in the project
+  // If true then skip creating a new group to avoid duplicate folders
+  if (xcodeProject.pbxTargetByName(CIO_NOTIFICATION_TARGET_NAME)) {
+    console.warn(
+      `${CIO_NOTIFICATION_TARGET_NAME} already exists in project. Skipping...`
+    );
+    return;
+  }
+
   const nsePath = `${iosPath}/${CIO_NOTIFICATION_TARGET_NAME}`;
   FileManagement.mkdir(nsePath, {
     recursive: true,
@@ -160,7 +172,7 @@ const addRichPushXcodeProj = async (
   // files / folder appear in the file explorer in Xcode.
   const groups = xcodeProject.hash.project.objects['PBXGroup'];
   Object.keys(groups).forEach((key) => {
-    if (groups[key].name === undefined) {
+    if (groups[key].name === undefined && groups[key].path === undefined) {
       xcodeProject.addToPbxGroup(extGroup.uuid, key);
     }
   });
@@ -290,13 +302,23 @@ const updateNseEnv = (
   }
 
   if (options.pushNotification?.env?.region) {
-    let region = '';
-    if (options.pushNotification?.env?.region === 'us') {
-      region = 'Region.US';
-    } else if (options.pushNotification?.env?.region === 'eu') {
-      region = 'Region.EU';
+    const regionMap = {
+      us: 'Region.US',
+      eu: 'Region.EU',
+    };
+    const region = options.pushNotification?.env?.region?.toLowerCase();
+    const mappedRegion = (regionMap as any)[region] || '';
+    if (!mappedRegion) {
+      console.warn(
+        `${options.pushNotification?.env?.region} is an invalid region. Please use the values from the docs: https://customer.io/docs/sdk/expo/getting-started/#configure-the-plugin`
+      );
+    } else {
+      envFileContent = replaceCodeByRegex(
+        envFileContent,
+        REGION_RE,
+        mappedRegion
+      );
     }
-    envFileContent = replaceCodeByRegex(envFileContent, REGION_RE, region);
   }
 
   FileManagement.writeFile(envFileName, envFileContent);
@@ -310,24 +332,50 @@ async function addPushNotificationFile(
   const file = 'PushService.swift';
   const appPath = `${iosPath}/${appName}`;
   const getTargetFile = (filename: string) => `${appPath}/${filename}`;
+  const targetFile = getTargetFile(file);
 
+  // Check whether {file} exists in the project. If false, then add the file
+  // If {file} exists then skip and return
   if (!FileManagement.exists(getTargetFile(file))) {
     FileManagement.mkdir(appPath, {
       recursive: true,
     });
 
-    const targetFile = getTargetFile(file);
     FileManagement.copyFile(
       `${LOCAL_PATH_TO_CIO_NSE_FILES}/${file}`,
       targetFile
     );
   } else {
     console.log(`${getTargetFile(file)} already exists. Skipping...`);
+    return;
   }
 
+  updatePushFile(options, targetFile);
+
   const group = xcodeProject.pbxCreateGroup('CustomerIONotifications');
   const classesKey = xcodeProject.findPBXGroupKey({ name: `${appName}` });
   xcodeProject.addToPbxGroup(group, classesKey);
 
   xcodeProject.addSourceFile(`${appName}/${file}`, null, group);
 }
+
+const updatePushFile = (
+  options: CustomerIOPluginOptionsIOS,
+  envFileName: string
+) => {
+  const REGISTER_RE = /\{\{REGISTER_SNIPPET\}\}/;
+
+  let envFileContent = FileManagement.readFile(envFileName);
+
+  let snippet = '';
+  if (
+    options.disableNotificationRegistration !== undefined &&
+    options.disableNotificationRegistration === false
+  ) {
+    snippet = CIO_REGISTER_PUSHNOTIFICATION_SNIPPET;
+  }
+
+  envFileContent = replaceCodeByRegex(envFileContent, REGISTER_RE, snippet);
+
+  FileManagement.writeFile(envFileName, envFileContent);
+};

package/src/types/cio-types.ts

@@ -15,6 +15,7 @@ export type CustomerIOPluginOptionsIOS = {
   iosDeploymentTarget?: string;
   appleTeamId?: string;
   appName?: string;
+  disableNotificationRegistration?: boolean;
   useFrameworks?: 'static' | 'dynamic';
   pushNotification?: {
     useRichPush: boolean;
@@ -29,6 +30,7 @@ export type CustomerIOPluginOptionsIOS = {
 export type CustomerIOPluginOptionsAndroid = {
   androidPath: string;
   googleServicesFile?: string;
+  setHighPriorityPushHandler?: boolean;
 };
 
 export type CustomerIOPluginOptions = {