customerio-expo-plugin 3.4.0 → 3.5.1

package/plugin/src/android/withGoogleServicesJSON.ts

@@ -5,38 +5,40 @@ import { logger } from '../utils/logger';
 import { FileManagement } from './../helpers/utils/fileManagement';
 import type { CustomerIOPluginOptionsAndroid } from './../types/cio-types';
 
-export const withGoogleServicesJSON: ConfigPlugin<
-  CustomerIOPluginOptionsAndroid
-> = (configOuter, cioProps) => {
-  return withProjectBuildGradle(configOuter, (props) => {
-    const options: CustomerIOPluginOptionsAndroid = {
-      androidPath: props.modRequest.platformProjectRoot,
-      googleServicesFile: cioProps?.googleServicesFile,
-    };
-    const { androidPath, googleServicesFile } = options;
-    if (!FileManagement.exists(`${androidPath}/app/google-services.json`)) {
-      if (googleServicesFile && FileManagement.exists(googleServicesFile)) {
-        try {
-          FileManagement.copyFile(
-            googleServicesFile,
-            `${androidPath}/app/google-services.json`
-          );
-        } catch {
-          logger.info(
-            `There was an error copying your google-services.json file. You can copy it manually into ${androidPath}/app/google-services.json`
-          );
-        }
-      } else {
-        logger.info(
-          `The Google Services file provided in ${googleServicesFile} doesn't seem to exist. You can copy it manually into ${androidPath}/app/google-services.json`
-        );
-      }
-    } else {
+export function copyGoogleServicesFile(
+  androidPath: string,
+  googleServicesFile: string | undefined
+): void {
+  const destination = `${androidPath}/app/google-services.json`;
+
+  if (FileManagement.exists(destination)) {
+    logger.info(`File already exists: ${destination}. Skipping...`);
+    return;
+  }
+
+  if (googleServicesFile && FileManagement.exists(googleServicesFile)) {
+    try {
+      FileManagement.copyFile(googleServicesFile, destination);
+    } catch {
       logger.info(
-        `File already exists: ${androidPath}/app/google-services.json. Skipping...`
+        `There was an error copying your google-services.json file. You can copy it manually into ${destination}`
       );
     }
+  } else {
+    logger.info(
+      `The Google Services file provided in ${googleServicesFile} doesn't seem to exist. You can copy it manually into ${destination}`
+    );
+  }
+}
 
+export const withGoogleServicesJSON: ConfigPlugin<
+  CustomerIOPluginOptionsAndroid
+> = (configOuter, cioProps) => {
+  return withProjectBuildGradle(configOuter, (props) => {
+    copyGoogleServicesFile(
+      props.modRequest.platformProjectRoot,
+      cioProps?.googleServicesFile
+    );
     return props;
   });
 };

package/plugin/src/android/withLocationGradleProperties.ts

@@ -6,6 +6,28 @@ import type { CustomerIOPluginLocationOptions } from '../types/cio-types';
 
 const CUSTOMERIO_LOCATION_ENABLED_KEY = 'customerio_location_enabled';
 
+export function modifyGradleProperties(
+  items: PropertiesItem[]
+): PropertiesItem[] {
+  const existingIndex = items.findIndex(
+    (item) => item.type === 'property' && item.key === CUSTOMERIO_LOCATION_ENABLED_KEY
+  );
+
+  const newItem: PropertiesItem = {
+    type: 'property',
+    key: CUSTOMERIO_LOCATION_ENABLED_KEY,
+    value: 'true',
+  };
+
+  if (existingIndex >= 0) {
+    items[existingIndex] = newItem;
+  } else {
+    items.push(newItem);
+  }
+
+  return items;
+}
+
 /**
  * Adds or updates customerio_location_enabled in android/gradle.properties when location.enabled is true.
  * The Customer.io React Native SDK reads this to enable the location native module.
@@ -19,23 +41,7 @@ export const withLocationGradleProperties: ConfigPlugin<{
 
   return withGradleProperties(config, (config) => {
     const items = config.modResults as PropertiesItem[];
-    const existingIndex = items.findIndex(
-      (item) => item.type === 'property' && item.key === CUSTOMERIO_LOCATION_ENABLED_KEY
-    );
-
-    const newItem: PropertiesItem = {
-      type: 'property',
-      key: CUSTOMERIO_LOCATION_ENABLED_KEY,
-      value: 'true',
-    };
-
-    if (existingIndex >= 0) {
-      items[existingIndex] = newItem;
-    } else {
-      items.push(newItem);
-    }
-
-    config.modResults = items;
+    config.modResults = modifyGradleProperties(items);
     return config;
   });
 };

package/plugin/src/android/withMainApplicationModifications.ts

@@ -36,6 +36,30 @@ const getLocationInitOptions = (
   trackingMode: sdkConfig?.location?.trackingMode,
 });
 
+const SDK_INITIALIZER_CLASS = 'CustomerIOSDKInitializer';
+const SDK_INITIALIZER_PACKAGE = 'io.customer.sdk.expo';
+const SDK_INITIALIZER_FILE = `${SDK_INITIALIZER_CLASS}.kt`;
+const SDK_INITIALIZER_IMPORT = `import ${SDK_INITIALIZER_PACKAGE}.${SDK_INITIALIZER_CLASS}`;
+
+/**
+ * Pure string transform: given the existing MainApplication contents, returns the contents
+ * with the CustomerIOSDKInitializer import and onCreate call injected (idempotent — if the
+ * initialize call is already present, the call-injection step is skipped).
+ */
+export function injectCustomerIOInitializerIntoMainApplication(
+  contents: string
+): string {
+  let next = addImportToFile(contents, SDK_INITIALIZER_IMPORT);
+  if (!next.includes(CIO_NATIVE_SDK_INITIALIZE_CALL)) {
+    next = addCodeToMethod(
+      next,
+      CIO_MAINAPPLICATION_ONCREATE_REGEX,
+      CIO_NATIVE_SDK_INITIALIZE_SNIPPET
+    );
+  }
+  return next;
+}
+
 /**
  * Setup CustomerIOSDKInitializer for Android auto initialization
  */
@@ -44,30 +68,16 @@ const setupCustomerIOSDKInitializer = (
   sdkConfig: NativeSDKConfig,
   location?: CustomerIOPluginLocationOptions,
 ): string => {
-  const SDK_INITIALIZER_CLASS = 'CustomerIOSDKInitializer';
-  const SDK_INITIALIZER_PACKAGE = 'io.customer.sdk.expo';
-
-  const SDK_INITIALIZER_FILE = `${SDK_INITIALIZER_CLASS}.kt`;
-  const SDK_INITIALIZER_IMPORT = `import ${SDK_INITIALIZER_PACKAGE}.${SDK_INITIALIZER_CLASS}`;
-
   const locationOptions = getLocationInitOptions(location, sdkConfig);
-  let content = config.modResults.contents;
 
   try {
     // Always regenerate the CustomerIOSDKInitializer file to reflect config changes
     copyTemplateFile(config, SDK_INITIALIZER_FILE, SDK_INITIALIZER_PACKAGE, (content) =>
       patchNativeSDKInitializer(content, PLATFORM.ANDROID, sdkConfig, locationOptions)
     );
-    // Add import if not already present
-    content = addImportToFile(content, SDK_INITIALIZER_IMPORT);
-    // Add initialization code to onCreate if not already present
-    if (!content.includes(CIO_NATIVE_SDK_INITIALIZE_CALL)) {
-      content = addCodeToMethod(content, CIO_MAINAPPLICATION_ONCREATE_REGEX, CIO_NATIVE_SDK_INITIALIZE_SNIPPET);
-    }
+    return injectCustomerIOInitializerIntoMainApplication(config.modResults.contents);
   } catch (error) {
     logger.warn(`Could not setup ${SDK_INITIALIZER_CLASS}:`, error);
     return config.modResults.contents;
   }
-
-  return content;
 };

package/plugin/src/android/withNotificationChannelMetadata.ts

@@ -7,7 +7,7 @@ import type { CustomerIOPluginOptionsAndroid } from '../types/cio-types';
 /**
  * Adds a metadata entry to the Android manifest if it doesn't already exist
  */
-const addMetadataIfNotExists = (
+export const addMetadataIfNotExists = (
   application: ManifestApplication,
   name: string,
   value: string

package/plugin/src/android/withProjectBuildGradle.ts

@@ -23,6 +23,40 @@ function shouldDisableAndroid16Support(
   return isExpoVersion53OrLower(config);
 }
 
+/**
+ * Pure string transform: injects an androidx resolution-strategy block into the
+ * project-level build.gradle's `allprojects { ... }` section when
+ * `disableAndroid16Support` is true. Idempotent — returns input unchanged if the
+ * snippet is already present, or if the flag is false.
+ */
+export function modifyProjectBuildGradleAndroid16Support(
+  contents: string,
+  options: { disableAndroid16Support: boolean }
+): string {
+  if (!options.disableAndroid16Support) {
+    return contents;
+  }
+
+  if (contents.includes('androidx.core:core-ktx:1.13.1')) {
+    return contents;
+  }
+
+  const resolutionStrategy = `
+    configurations.all {
+        resolutionStrategy {
+            // Disable Android 16 support by forcing older androidx versions
+            // Compatible with API 35 and AGP 8.8.2 (prevents API 36/AGP 8.9.1+ requirement)
+            force 'androidx.core:core-ktx:1.13.1'
+            force 'androidx.lifecycle:lifecycle-process:2.8.7'
+        }
+    }`;
+
+  return contents.replace(
+    /allprojects\s*\{/,
+    `allprojects {${resolutionStrategy}`
+  );
+}
+
 /**
  * Adds dependency resolution strategy to force specific androidx versions.
  * This disables Android 16 support for apps using Expo SDK 53 or older gradle versions.
@@ -38,34 +72,10 @@ export function withProjectBuildGradle(
   androidOptions?: CustomerIOPluginOptionsAndroid
 ): ExpoConfig {
   return withExpoProjectBuildGradle(config, (config) => {
-    const { modResults } = config;
-
-    // Check if Android 16 support should be disabled
-    if (!shouldDisableAndroid16Support(config, androidOptions)) {
-      return config;
-    }
-
-    // Skip if already applied
-    if (modResults.contents.includes('androidx.core:core-ktx:1.13.1')) {
-      return config;
-    }
-
-    const resolutionStrategy = `
-    configurations.all {
-        resolutionStrategy {
-            // Disable Android 16 support by forcing older androidx versions
-            // Compatible with API 35 and AGP 8.8.2 (prevents API 36/AGP 8.9.1+ requirement)
-            force 'androidx.core:core-ktx:1.13.1'
-            force 'androidx.lifecycle:lifecycle-process:2.8.7'
-        }
-    }`;
-
-    // Add resolution strategy inside allprojects block
-    modResults.contents = modResults.contents.replace(
-      /allprojects\s*\{/,
-      `allprojects {${resolutionStrategy}`
+    config.modResults.contents = modifyProjectBuildGradleAndroid16Support(
+      config.modResults.contents,
+      { disableAndroid16Support: shouldDisableAndroid16Support(config, androidOptions) }
     );
-
     return config;
   });
 }

package/plugin/src/android/withProjectGoogleServices.ts

@@ -7,19 +7,24 @@ import {
 } from './../helpers/constants/android';
 import type { CustomerIOPluginOptionsAndroid } from './../types/cio-types';
 
+export function modifyProjectBuildGradleForGoogleServices(contents: string): string {
+  const regex = new RegExp(CIO_PROJECT_GOOGLE_SNIPPET);
+  if (regex.test(contents)) {
+    return contents;
+  }
+  return contents.replace(
+    CIO_PROJECT_BUILDSCRIPTS_REGEX,
+    `$1\n${CIO_PROJECT_GOOGLE_SNIPPET}`
+  );
+}
+
 export const withProjectGoogleServices: ConfigPlugin<
   CustomerIOPluginOptionsAndroid
 > = (configOuter) => {
   return withProjectBuildGradle(configOuter, (props) => {
-    const regex = new RegExp(CIO_PROJECT_GOOGLE_SNIPPET);
-    const match = props.modResults.contents.match(regex);
-    if (!match) {
-      props.modResults.contents = props.modResults.contents.replace(
-        CIO_PROJECT_BUILDSCRIPTS_REGEX,
-        `$1\n${CIO_PROJECT_GOOGLE_SNIPPET}`
-      );
-    }
-
+    props.modResults.contents = modifyProjectBuildGradleForGoogleServices(
+      props.modResults.contents
+    );
     return props;
   });
 };

package/plugin/src/helpers/utils/injectCIOPodfileCode.ts

@@ -42,73 +42,108 @@ export function buildHostAppPodSnippet(
   return `pod 'customerio-reactnative', :subspecs => ['${pushSubspec}', 'location'], :path => '${resolvedPath}'`;
 }
 
-export async function injectCIOPodfileCode(
+const HOST_APP_BLOCK_START = '# --- CustomerIO Host App START ---';
+const HOST_APP_BLOCK_END = '# --- CustomerIO Host App END ---';
+const NOTIFICATION_BLOCK_START = '# --- CustomerIO Notification START ---';
+const NOTIFICATION_BLOCK_END = '# --- CustomerIO Notification END ---';
+
+/**
+ * Pure string transform: given the existing Podfile contents, returns the
+ * Podfile with the CustomerIO host-app block injected before the Expo
+ * `post_install do |installer|` anchor. Idempotent — returns input unchanged
+ * if the block is already present.
+ */
+export function injectHostAppPodfileCode(
+  podfileContent: string,
   iosPath: string,
   isFcmPushProvider: boolean,
   options?: InjectCIOPodfileOptions
-) {
-  const blockStart = '# --- CustomerIO Host App START ---';
-  const blockEnd = '# --- CustomerIO Host App END ---';
-
-  const filename = `${iosPath}/Podfile`;
-  const podfile = await FileManagement.read(filename);
-  const matches = podfile.match(new RegExp(blockStart));
-
-  if (!matches) {
-    // We need to decide what line of code in the Podfile to insert our native code.
-    // The "post_install" line is always present in an Expo project Podfile so it's reliable.
-    // Find that line in the Podfile and then we will insert our code above that line.
-    const lineInPodfileToInjectSnippetBefore = /post_install do \|installer\|/;
+): string {
+  if (podfileContent.match(new RegExp(HOST_APP_BLOCK_START))) {
+    return podfileContent;
+  }
 
-    const podLine = buildHostAppPodSnippet(iosPath, isFcmPushProvider, options);
+  // We need to decide what line of code in the Podfile to insert our native code.
+  // The "post_install" line is always present in an Expo project Podfile so it's reliable.
+  // Find that line in the Podfile and then we will insert our code above that line.
+  const lineInPodfileToInjectSnippetBefore = /post_install do \|installer\|/;
+  const podLine = buildHostAppPodSnippet(iosPath, isFcmPushProvider, options);
 
-    const snippetToInjectInPodfile = `
-${blockStart}
+  const snippetToInjectInPodfile = `
+${HOST_APP_BLOCK_START}
   ${podLine}
-${blockEnd}
+${HOST_APP_BLOCK_END}
 `.trim();
 
-    FileManagement.write(
-      filename,
-      injectCodeByRegex(
-        podfile,
-        lineInPodfileToInjectSnippetBefore,
-        snippetToInjectInPodfile
-      ).join('\n')
-    );
-  } else {
-    logger.info('CustomerIO Podfile snippets already exists. Skipping...');
-  }
+  return injectCodeByRegex(
+    podfileContent,
+    lineInPodfileToInjectSnippetBefore,
+    snippetToInjectInPodfile,
+  ).join('\n');
 }
 
-export async function injectCIONotificationPodfileCode(
+export async function injectCIOPodfileCode(
   iosPath: string,
-  useFrameworks: CustomerIOPluginOptionsIOS['useFrameworks'],
-  isFcmPushProvider: boolean
+  isFcmPushProvider: boolean,
+  options?: InjectCIOPodfileOptions
 ) {
   const filename = `${iosPath}/Podfile`;
   const podfile = await FileManagement.read(filename);
+  const next = injectHostAppPodfileCode(podfile, iosPath, isFcmPushProvider, options);
+  if (next !== podfile) {
+    FileManagement.write(filename, next);
+  } else {
+    logger.info('CustomerIO Podfile snippets already exists. Skipping...');
+  }
+}
 
-  const blockStart = '# --- CustomerIO Notification START ---';
-  const blockEnd = '# --- CustomerIO Notification END ---';
-
-  const matches = podfile.match(new RegExp(blockStart));
-
-  if (!matches) {
-    const resolvedPath = getRelativePathToRNSDK(iosPath);
-    const subspec = isFcmPushProvider ? 'fcm' : 'apn';
-    const useFrameworksLine =
-      useFrameworks === 'static' ? 'use_frameworks! :linkage => :static' : '';
+/**
+ * Pure string transform: given the existing Podfile contents, returns the
+ * Podfile with the rich-push NotificationService target block appended at
+ * the end. Idempotent — returns input unchanged if the block is already
+ * present.
+ */
+export function appendNotificationTargetToPodfile(
+  podfileContent: string,
+  iosPath: string,
+  isFcmPushProvider: boolean,
+  useFrameworks: CustomerIOPluginOptionsIOS['useFrameworks'],
+): string {
+  if (podfileContent.match(new RegExp(NOTIFICATION_BLOCK_START))) {
+    return podfileContent;
+  }
 
-    const snippetToInjectInPodfile = `
-${blockStart}
+  const snippetToAppend = `
+${NOTIFICATION_BLOCK_START}
 target 'NotificationService' do
-  ${useFrameworksLine}
-  pod 'customerio-reactnative-richpush/${subspec}', :path => '${resolvedPath}'
+  ${useFrameworks === 'static' ? 'use_frameworks! :linkage => :static' : ''}
+  pod 'customerio-reactnative-richpush/${isFcmPushProvider ? 'fcm' : 'apn'}', :path => '${getRelativePathToRNSDK(iosPath)}'
 end
-${blockEnd}
+${NOTIFICATION_BLOCK_END}
 `.trim();
 
-    FileManagement.append(filename, snippetToInjectInPodfile);
+  // Mirror FileManagement.append: append directly with no separator (real
+  // Podfiles end with a trailing newline, so the appended block starts on a
+  // fresh line in practice).
+  return `${podfileContent}${snippetToAppend}`;
+}
+
+export async function injectCIONotificationPodfileCode(
+  iosPath: string,
+  useFrameworks: CustomerIOPluginOptionsIOS['useFrameworks'],
+  isFcmPushProvider: boolean
+) {
+  const filename = `${iosPath}/Podfile`;
+  const podfile = await FileManagement.read(filename);
+  const next = appendNotificationTargetToPodfile(
+    podfile,
+    iosPath,
+    isFcmPushProvider,
+    useFrameworks,
+  );
+  if (next !== podfile) {
+    // FileManagement.append matches what the previous direct-append did.
+    // Slice off the leading content (already on disk) and append only the new tail.
+    FileManagement.append(filename, next.slice(podfile.length));
   }
 }

package/plugin/src/ios/withAppDelegateModifications.ts

@@ -153,9 +153,12 @@ const addFirebaseDelegateForwardDeclarationIfNeeded = (
   return stringContents;
 };
 
-const addAppdelegateHeaderModification = (stringContents: string) => {
-  // Add UNUserNotificationCenterDelegate if needed
-  stringContents = stringContents.replace(
+/**
+ * Pure string transform: ensures the AppDelegate header (Objective-C path) declares
+ * `UNUserNotificationCenterDelegate` and imports `UserNotifications`. Idempotent.
+ */
+export function modifyAppDelegateHeader(headerContent: string): string {
+  return headerContent.replace(
     CIO_APPDELEGATEHEADER_REGEX,
     (match, interfaceDeclaration, _groupedDelegates, existingDelegates) => {
       if (
@@ -179,9 +182,7 @@ ${interfaceDeclaration.trim()} <${CIO_APPDELEGATEHEADER_USER_NOTIFICATION_CENTER
       }
     }
   );
-
-  return stringContents;
-};
+}
 
 const addHandleDeeplinkInKilledState = (stringContents: string) => {
   // Find if the deep link code snippet is already present
@@ -219,59 +220,71 @@ const addHandleDeeplinkInKilledState = (stringContents: string) => {
   return stringContents;
 };
 
+/**
+ * Pure string transform: produces the modified Objective-C AppDelegate.m / AppDelegate.mm
+ * contents wired with the Customer.io push pipeline (imports, declarations, notification
+ * configuration, registration callbacks, optional killed-state deep-link, FCM forward decl,
+ * Expo notifications header). The caller is responsible for the AppDelegate header file
+ * (.h) — see `modifyAppDelegateHeader`.
+ */
+export function modifyAppDelegateContents(
+  contents: string,
+  projectName: string,
+  props: CustomerIOPluginOptionsIOS
+): string {
+  let next = addImport(contents, projectName);
+  next = addNotificationHandlerDeclaration(next);
+
+  // unless this property is explicity set to true, push notification
+  // registration will be added to the AppDelegate
+  if (props.pushNotification?.disableNotificationRegistration !== true) {
+    next = addNotificationConfiguration(next);
+  }
+
+  next = addInitializeNativeCioSdk(next);
+
+  if (props.pushNotification?.handleDeeplinkInKilledState === true) {
+    next = addHandleDeeplinkInKilledState(next);
+  }
+
+  next = addDidFailToRegisterForRemoteNotificationsWithError(next);
+  next = addDidRegisterForRemoteNotificationsWithDeviceToken(next);
+
+  if (isFcmPushProvider(props)) {
+    next = addFirebaseDelegateForwardDeclarationIfNeeded(next);
+  }
+
+  next = addExpoNotificationsHeaderModification(next);
+
+  return next;
+}
+
 export const withAppDelegateModifications: ConfigPlugin<
   CustomerIOPluginOptionsIOS
 > = (configOuter, props) => {
   return withAppDelegate(configOuter, async (config) => {
-    let stringContents = config.modResults.contents;
+    const stringContents = config.modResults.contents;
     const regex = new RegExp(
       `#import <${config.modRequest.projectName}-Swift.h>`
     );
-    const match = stringContents.match(regex);
-
-    if (!match) {
-      const headerPath = getAppDelegateHeaderFilePath(
-        config.modRequest.projectRoot
-      );
-      let headerContent = await FileManagement.read(headerPath);
-      headerContent = addAppdelegateHeaderModification(headerContent);
-      FileManagement.write(headerPath, headerContent);
-
-      stringContents = addImport(
-        stringContents,
-        config.modRequest.projectName as string
-      );
-      stringContents = addNotificationHandlerDeclaration(stringContents);
-
-      // unless this property is explicity set to true, push notification
-      // registration will be added to the AppDelegate
-      if (props.pushNotification?.disableNotificationRegistration !== true) {
-        stringContents = addNotificationConfiguration(stringContents);
-      }
-
-      stringContents = addInitializeNativeCioSdk(stringContents);
-
-      if (props.pushNotification?.handleDeeplinkInKilledState === true) {
-        stringContents = addHandleDeeplinkInKilledState(stringContents);
-      }
-
-      stringContents =
-        addDidFailToRegisterForRemoteNotificationsWithError(stringContents);
-      stringContents =
-        addDidRegisterForRemoteNotificationsWithDeviceToken(stringContents);
-
-      if (isFcmPushProvider(props)) {
-        stringContents =
-          addFirebaseDelegateForwardDeclarationIfNeeded(stringContents);
-      }
-
-      stringContents = addExpoNotificationsHeaderModification(stringContents);
 
-      config.modResults.contents = stringContents;
-    } else {
+    if (stringContents.match(regex)) {
       logger.info('Customerio AppDelegate changes already exist. Skipping...');
+      return config;
     }
 
+    const headerPath = getAppDelegateHeaderFilePath(
+      config.modRequest.projectRoot
+    );
+    const headerContent = await FileManagement.read(headerPath);
+    FileManagement.write(headerPath, modifyAppDelegateHeader(headerContent));
+
+    config.modResults.contents = modifyAppDelegateContents(
+      stringContents,
+      config.modRequest.projectName as string,
+      props
+    );
+
     return config;
   });
 };