customerio-expo-plugin 1.0.0-beta.12 → 1.0.0-beta.14

package/src/ios/withAppDelegateModifications.ts

@@ -3,36 +3,35 @@ import { getAppDelegateHeaderFilePath } from '@expo/config-plugins/build/ios/Pat
 
 import {
   CIO_APPDELEGATEDECLARATION_REGEX,
+  CIO_APPDELEGATEHEADER_IMPORT_SNIPPET,
   CIO_APPDELEGATEHEADER_REGEX,
-  CIO_APPDELEGATEHEADER_SNIPPET,
+  CIO_APPDELEGATEHEADER_USER_NOTIFICATION_CENTER_SNIPPET,
   CIO_CONFIGURECIOSDKPUSHNOTIFICATION_SNIPPET,
-  CIO_DIDFAILTOREGISTERFORREMOTENOTIFICATIONSWITHERRORFULL_REGEX,
+  CIO_CONFIGUREDEEPLINK_KILLEDSTATE_SNIPPET,
+  CIO_RCTBRIDGE_DEEPLINK_MODIFIEDOPTIONS_REGEX,
   CIO_DIDFAILTOREGISTERFORREMOTENOTIFICATIONSWITHERROR_REGEX,
   CIO_DIDFAILTOREGISTERFORREMOTENOTIFICATIONSWITHERROR_SNIPPET,
   CIO_DIDFINISHLAUNCHINGMETHOD_REGEX,
-  CIO_DIDRECEIVENOTIFICATIONRESPONSEHANDLER_SNIPPET,
   CIO_DIDREGISTERFORREMOTENOTIFICATIONSWITHDEVICETOKEN_REGEX,
   CIO_DIDREGISTERFORREMOTENOTIFICATIONSWITHDEVICETOKEN_SNIPPET,
+  CIO_LAUNCHOPTIONS_DEEPLINK_MODIFIEDOPTIONS_REGEX,
   CIO_PUSHNOTIFICATIONHANDLERDECLARATION_SNIPPET,
-  CIO_WILLPRESENTNOTIFICATIONHANDLER_SNIPPET,
+  CIO_LAUNCHOPTIONS_MODIFIEDOPTIONS_SNIPPET,
+  CIO_RCTBRIDGE_DEEPLINK_MODIFIEDOPTIONS_SNIPPET,
+  CIO_DEEPLINK_COMMENT_REGEX,
+  CIO_INITIALIZECIOSDK_SNIPPET,
 } from '../helpers/constants/ios';
 import {
+  injectCodeBeforeMultiLineRegex,
   injectCodeByLineNumber,
   injectCodeByMultiLineRegex,
   injectCodeByMultiLineRegexAndReplaceLine,
+  replaceCodeByRegex,
+  matchRegexExists,
 } from '../helpers/utils/codeInjection';
 import { FileManagement } from '../helpers/utils/fileManagement';
 import type { CustomerIOPluginOptionsIOS } from '../types/cio-types';
 
-const pushCodeSnippets = [
-  CIO_DIDRECEIVENOTIFICATIONRESPONSEHANDLER_SNIPPET,
-  CIO_WILLPRESENTNOTIFICATIONHANDLER_SNIPPET,
-];
-
-const additionalMethodsForPushNotifications = `${pushCodeSnippets.join(
-  '\n'
-)}\n`; // Join newlines and ensure a newline at the end.
-
 const addImport = (stringContents: string, appName: string) => {
   const importRegex = /^(#import .*)\n/gm;
   const addedImport = getImportSnippet(appName);
@@ -51,7 +50,7 @@ const addImport = (stringContents: string, appName: string) => {
     stringContents,
     endOfMatchIndex,
     addedImport
-  ).join('\n');
+  );
 
   return stringContents;
 };
@@ -67,7 +66,7 @@ const addNotificationHandlerDeclaration = (stringContents: string) => {
 };
 
 const addNotificationConfiguration = (stringContents: string) => {
-  stringContents = injectCodeByMultiLineRegex(
+  stringContents = injectCodeBeforeMultiLineRegex(
     stringContents,
     CIO_DIDFINISHLAUNCHINGMETHOD_REGEX,
     CIO_CONFIGURECIOSDKPUSHNOTIFICATION_SNIPPET
@@ -76,6 +75,29 @@ const addNotificationConfiguration = (stringContents: string) => {
   return stringContents;
 };
 
+const addInitializeNativeCioSdk = (stringContents: string) => {
+  stringContents = injectCodeBeforeMultiLineRegex(
+    stringContents,
+    CIO_DIDFINISHLAUNCHINGMETHOD_REGEX,
+    CIO_INITIALIZECIOSDK_SNIPPET
+  );
+
+  return stringContents;
+};
+
+const addHandleDeeplinkInKilledStateConfiguration = (
+  stringContents: string,
+  regex: RegExp
+) => {
+  stringContents = injectCodeBeforeMultiLineRegex(
+    stringContents,
+    regex,
+    CIO_CONFIGUREDEEPLINK_KILLEDSTATE_SNIPPET
+  );
+
+  return stringContents;
+};
+
 const addDidFailToRegisterForRemoteNotificationsWithError = (
   stringContents: string
 ) => {
@@ -100,26 +122,88 @@ const addDidRegisterForRemoteNotificationsWithDeviceToken = (
   return stringContents;
 };
 
-const addAdditionalMethodsForPushNotifications = (stringContents: string) => {
-  stringContents = injectCodeByMultiLineRegex(
+// Adds required import for Expo Notifications package in AppDelegate.
+// Required to call functions from the package.
+const addExpoNotificationsHeaderModification = (stringContents: string) => {
+  stringContents = injectCodeByLineNumber(
     stringContents,
-    CIO_DIDFAILTOREGISTERFORREMOTENOTIFICATIONSWITHERRORFULL_REGEX,
-    additionalMethodsForPushNotifications
+    0,
+    `
+#if __has_include(<EXNotifications/EXNotificationCenterDelegate.h>)
+#import <EXNotifications/EXNotificationCenterDelegate.h>
+#endif
+`
   );
 
   return stringContents;
 };
 
 const addAppdelegateHeaderModification = (stringContents: string) => {
-  stringContents = injectCodeByMultiLineRegexAndReplaceLine(
-    stringContents,
+  // Add UNUserNotificationCenterDelegate if needed
+  stringContents = stringContents.replace(
     CIO_APPDELEGATEHEADER_REGEX,
-    CIO_APPDELEGATEHEADER_SNIPPET
+    (match, interfaceDeclaration, _groupedDelegates, existingDelegates) => {
+      if (
+        existingDelegates &&
+        existingDelegates.includes(
+          CIO_APPDELEGATEHEADER_USER_NOTIFICATION_CENTER_SNIPPET
+        )
+      ) {
+        // The AppDelegate declaration already includes UNUserNotificationCenterDelegate, so we don't need to modify it
+        return match;
+      } else if (existingDelegates) {
+        // Other delegates exist, append ours
+        return `${CIO_APPDELEGATEHEADER_IMPORT_SNIPPET}
+${interfaceDeclaration}<${existingDelegates}, ${CIO_APPDELEGATEHEADER_USER_NOTIFICATION_CENTER_SNIPPET}>
+`;
+      } else {
+        // No delegates exist, add ours
+        return `${CIO_APPDELEGATEHEADER_IMPORT_SNIPPET}
+${interfaceDeclaration.trim()} <${CIO_APPDELEGATEHEADER_USER_NOTIFICATION_CENTER_SNIPPET}>
+`;
+      }
+    }
   );
 
   return stringContents;
 };
 
+const addHandleDeeplinkInKilledState = (stringContents: string) => {
+  // Find if the deep link code snippet is already present
+  if (matchRegexExists(stringContents, CIO_DEEPLINK_COMMENT_REGEX)) {
+    return stringContents;
+  }
+
+  // Check if the app delegate is using RCTBridge or LaunchOptions
+  let snippet = undefined;
+  let regex = CIO_LAUNCHOPTIONS_DEEPLINK_MODIFIEDOPTIONS_REGEX;
+  if (
+    matchRegexExists(
+      stringContents,
+      CIO_RCTBRIDGE_DEEPLINK_MODIFIEDOPTIONS_REGEX
+    )
+  ) {
+    snippet = CIO_RCTBRIDGE_DEEPLINK_MODIFIEDOPTIONS_SNIPPET;
+    regex = CIO_RCTBRIDGE_DEEPLINK_MODIFIEDOPTIONS_REGEX;
+  } else if (
+    matchRegexExists(
+      stringContents,
+      CIO_LAUNCHOPTIONS_DEEPLINK_MODIFIEDOPTIONS_REGEX
+    )
+  ) {
+    snippet = CIO_LAUNCHOPTIONS_MODIFIEDOPTIONS_SNIPPET;
+  }
+  // Add code only if the app delegate is using RCTBridge or LaunchOptions
+  if (snippet !== undefined) {
+    stringContents = addHandleDeeplinkInKilledStateConfiguration(
+      stringContents,
+      regex
+    );
+    stringContents = replaceCodeByRegex(stringContents, regex, snippet);
+  }
+  return stringContents;
+};
+
 export const withAppDelegateModifications: ConfigPlugin<
   CustomerIOPluginOptionsIOS
 > = (configOuter, props) => {
@@ -151,12 +235,23 @@ export const withAppDelegateModifications: ConfigPlugin<
       ) {
         stringContents = addNotificationConfiguration(stringContents);
       }
-      stringContents = addAdditionalMethodsForPushNotifications(stringContents);
+
+      stringContents = addInitializeNativeCioSdk(stringContents);
+
+      if (
+        props.handleDeeplinkInKilledState !== undefined &&
+        props.handleDeeplinkInKilledState === true
+      ) {
+        stringContents = addHandleDeeplinkInKilledState(stringContents);
+      }
+
       stringContents =
         addDidFailToRegisterForRemoteNotificationsWithError(stringContents);
       stringContents =
         addDidRegisterForRemoteNotificationsWithDeviceToken(stringContents);
 
+      stringContents = addExpoNotificationsHeaderModification(stringContents);
+
       config.modResults.contents = stringContents;
     } else {
       console.log('Customerio AppDelegate changes already exist. Skipping...');

package/src/ios/withNotificationsXcodeProject.ts

@@ -374,8 +374,43 @@ const updatePushFile = (
   ) {
     snippet = CIO_REGISTER_PUSHNOTIFICATION_SNIPPET;
   }
-
   envFileContent = replaceCodeByRegex(envFileContent, REGISTER_RE, snippet);
 
+  if (options.pushNotification) {
+    envFileContent = replaceCodeByRegex(
+      envFileContent,
+      /\{\{SITE_ID\}\}/,
+      options.pushNotification.env.siteId
+    );
+    envFileContent = replaceCodeByRegex(
+      envFileContent,
+      /\{\{API_KEY\}\}/,
+      options.pushNotification.env.apiKey
+    );
+    envFileContent = replaceCodeByRegex(
+      envFileContent,
+      /\{\{REGION\}\}/,
+      options.pushNotification.env.region.toUpperCase()
+    );
+  }
+
+  const autoTrackPushEvents =
+    options.autoTrackPushEvents === undefined ||
+    options.autoTrackPushEvents === true;
+  envFileContent = replaceCodeByRegex(
+    envFileContent,
+    /\{\{AUTO_TRACK_PUSH_EVENTS\}\}/,
+    autoTrackPushEvents.toString()
+  );
+
+  const showPushAppInForeground =
+    options.showPushAppInForeground === undefined ||
+    options.showPushAppInForeground === true;
+  envFileContent = replaceCodeByRegex(
+    envFileContent,
+    /\{\{SHOW_PUSH_APP_IN_FOREGROUND\}\}/,
+    showPushAppInForeground.toString()
+  );
+
   FileManagement.writeFile(envFileName, envFileContent);
 };

package/src/types/cio-types.ts

@@ -16,6 +16,13 @@ export type CustomerIOPluginOptionsIOS = {
   appleTeamId?: string;
   appName?: string;
   disableNotificationRegistration?: boolean;
+  /**
+   * @deprecated No longer has any effect. Use autoTrackPushEvents to control if push metrics should be automatically tracked by SDK.
+   */
+  handleNotificationClick?: boolean;
+  showPushAppInForeground?: boolean;
+  autoTrackPushEvents?: boolean;
+  handleDeeplinkInKilledState?: boolean;
   useFrameworks?: 'static' | 'dynamic';
   pushNotification?: {
     useRichPush: boolean;