customerio-expo-plugin 2.0.0 → 2.0.2

package/plugin/src/ios/withCIOIos.ts

@@ -1,6 +1,6 @@
 import type { ExpoConfig } from '@expo/config-types';
 
-import type { CustomerIOPluginOptionsIOS } from '../types/cio-types';
+import type { CustomerIOPluginOptionsIOS, CustomerIOPluginPushNotificationOptions } from '../types/cio-types';
 import { withAppDelegateModifications } from './withAppDelegateModifications';
 import { withCioNotificationsXcodeProject } from './withNotificationsXcodeProject';
 import { withCioXcodeProject } from './withXcodeProject';
@@ -10,12 +10,63 @@ export function withCIOIos(
   config: ExpoConfig,
   props: CustomerIOPluginOptionsIOS
 ) {
-  if (props.pushNotification) {
-    config = withAppDelegateModifications(config, props);
-    config = withCioNotificationsXcodeProject(config, props);
-    config = withCioXcodeProject(config, props);
-    config = withGoogleServicesJsonFile(config, props);
+  const cioProps = mergeDeprecatedPropertiesAndLogWarnings(props);
+  if (cioProps.pushNotification) {
+    config = withAppDelegateModifications(config, cioProps);
+    config = withCioNotificationsXcodeProject(config, cioProps);
+    config = withCioXcodeProject(config, cioProps);
+    config = withGoogleServicesJsonFile(config, cioProps);
   }
 
   return config;
 }
+
+/**  The basic purpose of this function is to centralize where we handle the deprecation
+  by merging the deprecated properties into the new ios.pushNotification.* properties
+  and logging a warning if they are set. This way, we can remove the deprecated properties
+  from the top level of the ios object in the future, and update this function
+  while the rest of the plugin code remains unchanged.
+*/
+const mergeDeprecatedPropertiesAndLogWarnings = (
+  props: CustomerIOPluginOptionsIOS
+) => {
+  // The deprecatedTopLevelProperties maps the top level properties
+  // that are deprecated to the new ios.pushNotification.* properties
+  // that should be used instead. The deprecated properties are
+  // still available for backwards compatibility, but they will
+  // be removed in the future.
+
+  const deprecatedTopLevelProperties = {
+    showPushAppInForeground: props.showPushAppInForeground,
+    autoTrackPushEvents: props.autoTrackPushEvents,
+    handleDeeplinkInKilledState: props.handleDeeplinkInKilledState,
+    disableNotificationRegistration: props.disableNotificationRegistration,
+    autoFetchDeviceToken: props.autoFetchDeviceToken,
+  };
+
+  // loop over all the deprecated properties and log a warning if they are set
+  Object.entries(deprecatedTopLevelProperties).forEach(([key, value]) => {
+    if (value !== undefined) {
+      console.warn(
+        `The ios.${key} property is deprecated. Please use ios.pushNotification.${key} instead.`
+      );
+
+      if (props.pushNotification === undefined) {
+        props.pushNotification = {} as CustomerIOPluginPushNotificationOptions;
+      }
+      const propKey = key as keyof CustomerIOPluginPushNotificationOptions;
+      if (props.pushNotification[propKey] === undefined) {
+        props.pushNotification = {
+          ...props.pushNotification,
+          [propKey]: value,
+        };
+      } else {
+        console.warn(
+          `The ios.${key} property is deprecated. Since the value of ios.pushNotification.${key} is set, it will be used.`
+        );
+      }
+    }
+  });
+
+  return props;
+};

package/plugin/src/ios/withNotificationsXcodeProject.ts

@@ -30,7 +30,7 @@ const addNotificationServiceExtension = async (
       await addPushNotificationFile(options, xcodeProject);
     }
 
-    if (options.pushNotification?.useRichPush) {
+    if (options.pushNotification?.useRichPush === true) {
       await addRichPushXcodeProj(options, xcodeProject);
     }
     return xcodeProject;
@@ -45,12 +45,7 @@ export const withCioNotificationsXcodeProject: ConfigPlugin<
 > = (configOuter, props) => {
   return withXcodeProject(configOuter, async (config) => {
     const { modRequest, ios, version: bundleShortVersion } = config;
-    const {
-      appleTeamId,
-      iosDeploymentTarget,
-      pushNotification,
-      useFrameworks,
-    } = props;
+    const { appleTeamId, iosDeploymentTarget, useFrameworks } = props;
 
     if (ios === undefined)
       throw new Error(
@@ -89,8 +84,7 @@ export const withCioNotificationsXcodeProject: ConfigPlugin<
       appName: projectName,
       useFrameworks,
       iosDeploymentTarget,
-      pushNotification,
-    };
+    } satisfies CustomerIOPluginOptionsIOS;
 
     const modifiedProjectFile = await addNotificationServiceExtension(
       options,
@@ -137,9 +131,7 @@ const addRichPushXcodeProj = async (
     recursive: true,
   });
 
-  const platformSpecificFiles = [
-    'NotificationService.swift',
-  ];
+  const platformSpecificFiles = ['NotificationService.swift'];
 
   const commonFiles = [
     PLIST_FILENAME,
@@ -153,13 +145,15 @@ const addRichPushXcodeProj = async (
   platformSpecificFiles.forEach((filename) => {
     const targetFile = getTargetFile(filename);
     FileManagement.copyFile(
-      `${LOCAL_PATH_TO_CIO_NSE_FILES}/${isFcmProvider ? "fcm" : "apn"}/${filename}`,
+      `${LOCAL_PATH_TO_CIO_NSE_FILES}/${
+        isFcmProvider ? 'fcm' : 'apn'
+      }/${filename}`,
       targetFile
     );
   });
 
-   // Copy common files
-   commonFiles.forEach((filename) => {
+  // Copy common files
+  commonFiles.forEach((filename) => {
     const targetFile = getTargetFile(filename);
     FileManagement.copyFile(
       `${LOCAL_PATH_TO_CIO_NSE_FILES}/common/${filename}`,
@@ -298,25 +292,31 @@ const updateNseEnv = (
   const REGION_RE = /\{\{REGION\}\}/;
 
   let envFileContent = FileManagement.readFile(envFileName);
-
-  if (options.pushNotification?.env?.cdpApiKey) {
-    envFileContent = replaceCodeByRegex(
-      envFileContent,
-      CDP_API_KEY_RE,
-      options.pushNotification?.env?.cdpApiKey
+  const { cdpApiKey, region } = options.pushNotification?.env || {
+    cdpApiKey: undefined,
+    region: undefined,
+  };
+
+  if (!cdpApiKey) {
+    throw new Error(
+      'Adding NotificationServiceExtension failed: ios.pushNotification.env.cdpApiKey is missing from app.config.js or app.json.'
     );
   }
+  envFileContent = replaceCodeByRegex(
+    envFileContent,
+    CDP_API_KEY_RE,
+    cdpApiKey
+  );
 
-  if (options.pushNotification?.env?.region) {
+  if (region) {
     const regionMap = {
       us: 'Region.US',
       eu: 'Region.EU',
     };
-    const region = options.pushNotification?.env?.region?.toLowerCase();
-    const mappedRegion = (regionMap as any)[region] || '';
+    const mappedRegion = (regionMap as any)[region.toLowerCase()] || '';
     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`
+        `${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(
@@ -338,7 +338,7 @@ async function addPushNotificationFile(
   const { iosPath, appName } = options;
   const isFcmProvider = isFcmPushProvider(options);
   // PushService.swift is platform-specific and always lives in the platform folder
-  const sourceFile = `${isFcmProvider ? "fcm" : "apn"}/PushService.swift`;
+  const sourceFile = `${isFcmProvider ? 'fcm' : 'apn'}/PushService.swift`;
   const targetFileName = 'PushService.swift';
   const appPath = `${iosPath}/${appName}`;
   const getTargetFile = (filename: string) => `${appPath}/${filename}`;
@@ -376,50 +376,58 @@ const updatePushFile = (
   const REGISTER_RE = /\{\{REGISTER_SNIPPET\}\}/;
 
   let envFileContent = FileManagement.readFile(envFileName);
+  const disableNotificationRegistration =
+    options.pushNotification?.disableNotificationRegistration;
+  const { cdpApiKey, region } = options.pushNotification?.env || {
+    cdpApiKey: undefined,
+    region: undefined,
+  };
+  if (!cdpApiKey) {
+    throw new Error(
+      'Adding NotificationServiceExtension failed: ios.pushNotification.env.cdpApiKey is missing from app.config.js or app.json.'
+    );
+  }
 
   let snippet = '';
-  if (
-    options.disableNotificationRegistration !== undefined &&
-    options.disableNotificationRegistration === false
-  ) {
+  // unless this property is explicity set to true, push notification
+  // registration will be added to the AppDelegate
+  if (disableNotificationRegistration !== true) {
     snippet = CIO_REGISTER_PUSHNOTIFICATION_SNIPPET;
   }
   envFileContent = replaceCodeByRegex(envFileContent, REGISTER_RE, snippet);
 
-  if (options.pushNotification) {
-    envFileContent = replaceCodeByRegex(
-      envFileContent,
-      /\{\{CDP_API_KEY\}\}/,
-      options.pushNotification.env.cdpApiKey
-    );
+  envFileContent = replaceCodeByRegex(
+    envFileContent,
+    /\{\{CDP_API_KEY\}\}/,
+    cdpApiKey
+  );
+
+  if (region) {
     envFileContent = replaceCodeByRegex(
       envFileContent,
       /\{\{REGION\}\}/,
-      options.pushNotification.env.region.toUpperCase()
+      region.toUpperCase()
     );
   }
 
   const autoTrackPushEvents =
-    options.autoTrackPushEvents === undefined ||
-    options.autoTrackPushEvents === true;
+    options.pushNotification?.autoTrackPushEvents !== false;
   envFileContent = replaceCodeByRegex(
     envFileContent,
     /\{\{AUTO_TRACK_PUSH_EVENTS\}\}/,
     autoTrackPushEvents.toString()
   );
 
-  const autoFetchDeviceToken = 
-    options.autoFetchDeviceToken === undefined ||
-    options.autoFetchDeviceToken === true;
+  const autoFetchDeviceToken =
+    options.pushNotification?.autoFetchDeviceToken !== false;
   envFileContent = replaceCodeByRegex(
     envFileContent,
     /\{\{AUTO_FETCH_DEVICE_TOKEN\}\}/,
     autoFetchDeviceToken.toString()
   );
-  
+
   const showPushAppInForeground =
-    options.showPushAppInForeground === undefined ||
-    options.showPushAppInForeground === true;
+    options.pushNotification?.showPushAppInForeground !== false;
   envFileContent = replaceCodeByRegex(
     envFileContent,
     /\{\{SHOW_PUSH_APP_IN_FOREGROUND\}\}/,

package/plugin/src/ios/withXcodeProject.ts

@@ -1,23 +1,15 @@
 import { ConfigPlugin, withXcodeProject } from '@expo/config-plugins';
 
+import { isFcmPushProvider } from './utils';
 import { injectCIOPodfileCode } from '../helpers/utils/injectCIOPodfileCode';
 import type { CustomerIOPluginOptionsIOS } from '../types/cio-types';
-import { isFcmPushProvider } from './utils';
 
 export const withCioXcodeProject: ConfigPlugin<CustomerIOPluginOptionsIOS> = (
   config,
   cioProps
 ) => {
   return withXcodeProject(config, async (props) => {
-    const options: CustomerIOPluginOptionsIOS = {
-      iosPath: props.modRequest.platformProjectRoot,
-      bundleIdentifier: props.ios?.bundleIdentifier,
-      devTeam: cioProps?.devTeam,
-      bundleVersion: props.ios?.buildNumber,
-      bundleShortVersion: props?.version,
-      iosDeploymentTarget: cioProps?.iosDeploymentTarget,
-    };
-    const { iosPath } = options;
+    const iosPath = props.modRequest.platformProjectRoot;
 
     await injectCIOPodfileCode(iosPath, isFcmPushProvider(cioProps));
 

package/plugin/src/types/cio-types.ts

@@ -15,25 +15,40 @@ export type CustomerIOPluginOptionsIOS = {
   iosDeploymentTarget?: string;
   appleTeamId?: string;
   appName?: string;
-  disableNotificationRegistration?: boolean;
+
+  useFrameworks?: 'static' | 'dynamic';
+
+  pushNotification?: CustomerIOPluginPushNotificationOptions;
+
   /**
    * @deprecated No longer has any effect. Use autoTrackPushEvents to control if push metrics should be automatically tracked by SDK.
    */
   handleNotificationClick?: boolean;
+
+  /**
+   * @deprecated Property will be removed in the future. Use ios.pushNotification.autoFetchDeviceToken instead
+   */
+  autoFetchDeviceToken?: boolean;
+
+  /**
+   * @deprecated Property will be removed in the future. Use ios.pushNotification.showPushAppInForeground instead
+   */
   showPushAppInForeground?: boolean;
+
+  /**
+   * @deprecated Property will be removed in the future. Use ios.pushNotification.autoTrackPushEvents instead
+   */
   autoTrackPushEvents?: boolean;
-  autoFetchDeviceToken?: boolean;
+
+  /**
+   * @deprecated Property will be removed in the future. Use ios.pushNotification.handleDeeplinkInKilledState instead
+   */
   handleDeeplinkInKilledState?: boolean;
-  useFrameworks?: 'static' | 'dynamic';
-  pushNotification?: {
-    provider?: 'apn' | 'fcm';
-    googleServicesFile?: string;
-    useRichPush: boolean;
-    env: {
-      cdpApiKey: string;
-      region: string;
-    };
-  };
+
+  /**
+   * @deprecated Property will be removed in the future. Use ios.pushNotification.disableNotificationRegistration instead
+   */
+  disableNotificationRegistration?: boolean;
 };
 
 export type CustomerIOPluginOptionsAndroid = {
@@ -46,3 +61,23 @@ export type CustomerIOPluginOptions = {
   android: CustomerIOPluginOptionsAndroid;
   ios: CustomerIOPluginOptionsIOS;
 };
+
+export type CustomerIOPluginPushNotificationOptions = {
+  provider?: 'apn' | 'fcm';
+  googleServicesFile?: string;
+  useRichPush?: boolean;
+  autoFetchDeviceToken?: boolean;
+  autoTrackPushEvents?: boolean;
+  showPushAppInForeground?: boolean;
+  disableNotificationRegistration?: boolean;
+  handleDeeplinkInKilledState?: boolean;
+
+  /**
+   * These values will be used to initialize the Notification Service Extension (NSE) on the native side.
+   * They should match the values you use to initialize the SDK in your app
+   */
+  env: {
+    cdpApiKey: string;
+    region: string;
+  };
+};