onesignal-expo-plugin 2.1.0 → 2.2.0

package/README.md

@@ -88,6 +88,7 @@ You can pass props to the plugin config object to configure:
 | `smallIconAccentColor`   | optional     | The accent color to use for notification icons on Android. Must be a valid hex value, e.g: `"#FF0000"`                                                                                                                                                                                                                                                                        |
 | `iosNSEFilePath`         | optional     | The local path to a custom Notification Service Extension (NSE), written in Objective-C. The NSE will typically start as a copy of the [default NSE](https://github.com/OneSignal/onesignal-expo-plugin/blob/main/support/serviceExtensionFiles/NotificationService.m), then altered to support any custom logic required. e.g: `"./assets/NotificationService.m"`.           |
 | `appGroupName`           | optional     | Used to configure a custom iOS [App Group](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-create-an-app-group) name. If not provided, defaults to `"group.{ios.bundleIdentifier}.onesignal"`. e.g: `"group.com.example.myapp.onesignal2"`. |
+| `nseBundleIdentifier`    | optional     | Used to configure a custom bundle identifier suffix for the iOS Notification Service Extension. The full bundle identifier will be `"{ios.bundleIdentifier}.{nseBundleIdentifier}"`. If not provided, defaults to `"OneSignalNotificationServiceExtension"`. |
 
 ### OneSignal App ID
 

package/build/onesignal/withOneSignalIos.js

@@ -45,6 +45,7 @@ const config_plugins_1 = require("@expo/config-plugins");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const iosConstants_1 = require("../support/iosConstants");
+const helpers_1 = require("../support/helpers");
 const updatePodfile_1 = require("../support/updatePodfile");
 const NseUpdaterManager_1 = __importDefault(require("../support/NseUpdaterManager"));
 const OneSignalLog_1 = require("../support/OneSignalLog");
@@ -96,7 +97,7 @@ const withAppGroupPermissions = (config, props) => {
             newConfig.modResults[APP_GROUP_KEY] = [];
         }
         const modResultsArray = newConfig.modResults[APP_GROUP_KEY];
-        const entitlement = (0, iosConstants_1.getAppGroupIdentifier)(newConfig?.ios?.bundleIdentifier || '', props?.appGroupName);
+        const entitlement = (0, helpers_1.getAppGroupIdentifier)(newConfig?.ios?.bundleIdentifier || '', props?.appGroupName);
         if (modResultsArray.indexOf(entitlement) !== -1) {
             return newConfig;
         }
@@ -118,18 +119,15 @@ const withCustomAppGroupsKey = (config, props) => {
 };
 const withEasManagedCredentials = (config, props) => {
     (0, assert_1.default)(config.ios?.bundleIdentifier, "Missing 'ios.bundleIdentifier' in app config.");
-    config.extra = (0, getEasManagedCredentialsConfigExtra_1.default)(config, props?.appGroupName);
+    config.extra = (0, getEasManagedCredentialsConfigExtra_1.default)(config, props?.appGroupName, props?.nseBundleIdentifier);
     return config;
 };
 const withOneSignalPodfile = (config) => {
     return (0, config_plugins_1.withDangerousMod)(config, [
         'ios',
         async (config) => {
-            // not awaiting in order to not block main thread
             const iosRoot = path.join(config.modRequest.projectRoot, 'ios');
-            (0, updatePodfile_1.updatePodfile)(iosRoot).catch((err) => {
-                OneSignalLog_1.OneSignalLog.error(err);
-            });
+            await (0, updatePodfile_1.updatePodfile)(iosRoot);
             return config;
         },
     ]);
@@ -143,19 +141,19 @@ const withOneSignalNSE = (config, props) => {
         async (config) => {
             const iosPath = path.join(config.modRequest.projectRoot, 'ios');
             /* COPY OVER EXTENSION FILES */
-            fs.mkdirSync(`${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`, { recursive: true });
-            for (let i = 0; i < iosConstants_1.NSE_EXT_FILES.length; i++) {
-                const extFile = iosConstants_1.NSE_EXT_FILES[i];
-                const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${extFile}`;
-                await FileManager_1.FileManager.copyFile(`${sourceDir}${extFile}`, targetFile);
+            fs.mkdirSync(`${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`, {
+                recursive: true,
+            });
+            for (const file of iosConstants_1.NSE_EXT_FILES) {
+                const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${file}`;
+                await FileManager_1.FileManager.copyFile(`${sourceDir}${file}`, targetFile);
             }
-            // Copy NSE source file either from configuration-provided location, falling back to the default one.
             const sourcePath = props.iosNSEFilePath ?? `${sourceDir}${iosConstants_1.NSE_SOURCE_FILE}`;
             const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${iosConstants_1.NSE_SOURCE_FILE}`;
             await FileManager_1.FileManager.copyFile(`${sourcePath}`, targetFile);
             /* MODIFY COPIED EXTENSION FILES */
             const nseUpdater = new NseUpdaterManager_1.default(iosPath);
-            const appGroupId = (0, iosConstants_1.getAppGroupIdentifier)(config.ios?.bundleIdentifier ?? '', props.appGroupName);
+            const appGroupId = (0, helpers_1.getAppGroupIdentifier)(config.ios?.bundleIdentifier ?? '', props.appGroupName);
             await nseUpdater.updateNSEEntitlements(appGroupId);
             if (props.appGroupName) {
                 await nseUpdater.updateNSEInfoPlistAppGroupKey(props.appGroupName);
@@ -169,6 +167,7 @@ const withOneSignalNSE = (config, props) => {
 const withOneSignalXcodeProject = (config, props) => {
     return (0, config_plugins_1.withXcodeProject)(config, (newConfig) => {
         const xcodeProject = newConfig.modResults;
+        const nseBundleId = `${config.ios?.bundleIdentifier}.${props.nseBundleIdentifier ?? iosConstants_1.NSE_TARGET_NAME}`;
         if (xcodeProject.pbxTargetByName(iosConstants_1.NSE_TARGET_NAME)) {
             OneSignalLog_1.OneSignalLog.log(`${iosConstants_1.NSE_TARGET_NAME} already exists in project. Skipping...`);
             return newConfig;
@@ -196,7 +195,7 @@ const withOneSignalXcodeProject = (config, props) => {
             projObjects['PBXTargetDependency'] || {};
         // Add the NSE target
         // This adds PBXTargetDependency and PBXContainerItemProxy for you
-        const nseTarget = xcodeProject.addTarget(iosConstants_1.NSE_TARGET_NAME, 'app_extension', iosConstants_1.NSE_TARGET_NAME, `${config.ios?.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`);
+        const nseTarget = xcodeProject.addTarget(iosConstants_1.NSE_TARGET_NAME, 'app_extension', iosConstants_1.NSE_TARGET_NAME, nseBundleId);
         // Add build phases to the new target
         xcodeProject.addBuildPhase(['NotificationService.m'], 'PBXSourcesBuildPhase', 'Sources', nseTarget.uuid);
         xcodeProject.addBuildPhase([], 'PBXResourcesBuildPhase', 'Resources', nseTarget.uuid);

package/build/support/NseUpdaterManager.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const FileManager_1 = require("./FileManager");
 const iosConstants_1 = require("./iosConstants");
-// project `ios/OneSignalNotificationServiceExtension` directory
-const entitlementsFileName = `OneSignalNotificationServiceExtension.entitlements`;
-const plistFileName = `OneSignalNotificationServiceExtension-Info.plist`;
+const entitlementsFileName = `${iosConstants_1.NSE_TARGET_NAME}.entitlements`;
+const plistFileName = `${iosConstants_1.NSE_TARGET_NAME}-Info.plist`;
 class NseUpdaterManager {
-    nsePath = '';
+    nsePath;
     constructor(iosPath) {
         this.nsePath = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`;
     }

package/build/support/eas/getEasManagedCredentialsConfigExtra.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = getEasManagedCredentialsConfigExtra;
 const iosConstants_1 = require("../iosConstants");
-function getEasManagedCredentialsConfigExtra(config, appGroupName) {
+const helpers_1 = require("../helpers");
+function getEasManagedCredentialsConfigExtra(config, appGroupName, nseBundleIdentifier) {
+    const bundleId = `${config?.ios?.bundleIdentifier}.${nseBundleIdentifier ?? iosConstants_1.NSE_TARGET_NAME}`;
     return {
         ...config.extra,
         eas: {
@@ -17,12 +19,11 @@ function getEasManagedCredentialsConfigExtra(config, appGroupName) {
                             ...(config.extra?.eas?.build?.experimental?.ios?.appExtensions ??
                                 []),
                             {
-                                // keep in sync with native changes in NSE
                                 targetName: iosConstants_1.NSE_TARGET_NAME,
-                                bundleIdentifier: `${config?.ios?.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`,
+                                bundleIdentifier: bundleId,
                                 entitlements: {
                                     'com.apple.security.application-groups': [
-                                        (0, iosConstants_1.getAppGroupIdentifier)(config?.ios?.bundleIdentifier ?? '', appGroupName),
+                                        (0, helpers_1.getAppGroupIdentifier)(config?.ios?.bundleIdentifier ?? '', appGroupName),
                                     ],
                                 },
                             },

package/build/support/helpers.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatePluginProps = validatePluginProps;
+exports.getAppGroupIdentifier = getAppGroupIdentifier;
 const types_1 = require("../types/types");
 function validatePluginProps(props) {
     // check the type of each property
@@ -30,6 +31,10 @@ function validatePluginProps(props) {
     if (props.appGroupName && typeof props.appGroupName !== 'string') {
         throw new Error("OneSignal Expo Plugin: 'appGroupName' must be a string.");
     }
+    if (props.nseBundleIdentifier &&
+        typeof props.nseBundleIdentifier !== 'string') {
+        throw new Error("OneSignal Expo Plugin: 'nseBundleIdentifier' must be a string.");
+    }
     // check for extra properties
     const inputProps = Object.keys(props);
     for (const prop of inputProps) {
@@ -38,3 +43,6 @@ function validatePluginProps(props) {
         }
     }
 }
+function getAppGroupIdentifier(bundleIdentifier, customAppGroupName) {
+    return customAppGroupName ?? `group.${bundleIdentifier}.onesignal`;
+}

package/build/support/iosConstants.js

@@ -1,25 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NSE_EXT_FILES = exports.NSE_SOURCE_FILE = exports.NSE_TARGET_NAME = exports.DEFAULT_BUNDLE_SHORT_VERSION = exports.DEFAULT_BUNDLE_VERSION = exports.BUNDLE_VERSION_TEMPLATE_REGEX = exports.BUNDLE_SHORT_VERSION_TEMPLATE_REGEX = exports.GROUP_IDENTIFIER_TEMPLATE_REGEX = exports.NSE_PODFILE_REGEX = exports.NSE_PODFILE_SNIPPET = exports.TARGETED_DEVICE_FAMILY = exports.IPHONEOS_DEPLOYMENT_TARGET = void 0;
-exports.getAppGroupIdentifier = getAppGroupIdentifier;
+exports.NSE_EXT_FILES = exports.NSE_PODFILE_REGEX = exports.NSE_PODFILE_SNIPPET = exports.NSE_SOURCE_FILE = exports.NSE_TARGET_NAME = exports.DEFAULT_BUNDLE_SHORT_VERSION = exports.DEFAULT_BUNDLE_VERSION = exports.BUNDLE_VERSION_TEMPLATE_REGEX = exports.BUNDLE_SHORT_VERSION_TEMPLATE_REGEX = exports.GROUP_IDENTIFIER_TEMPLATE_REGEX = exports.TARGETED_DEVICE_FAMILY = exports.IPHONEOS_DEPLOYMENT_TARGET = void 0;
 exports.IPHONEOS_DEPLOYMENT_TARGET = '11.0';
 exports.TARGETED_DEVICE_FAMILY = `"1,2"`;
-exports.NSE_PODFILE_SNIPPET = `
-target 'OneSignalNotificationServiceExtension' do
-  pod 'OneSignalXCFramework', '>= 5.0', '< 6.0'
-  use_frameworks! :linkage => podfile_properties['ios.useFrameworks'].to_sym if podfile_properties['ios.useFrameworks']
-end`;
-exports.NSE_PODFILE_REGEX = /target 'OneSignalNotificationServiceExtension'/;
 exports.GROUP_IDENTIFIER_TEMPLATE_REGEX = /{{GROUP_IDENTIFIER}}/gm;
 exports.BUNDLE_SHORT_VERSION_TEMPLATE_REGEX = /{{BUNDLE_SHORT_VERSION}}/gm;
 exports.BUNDLE_VERSION_TEMPLATE_REGEX = /{{BUNDLE_VERSION}}/gm;
 exports.DEFAULT_BUNDLE_VERSION = '1';
 exports.DEFAULT_BUNDLE_SHORT_VERSION = '1.0';
 exports.NSE_TARGET_NAME = 'OneSignalNotificationServiceExtension';
-function getAppGroupIdentifier(bundleIdentifier, customAppGroupName) {
-    return customAppGroupName ?? `group.${bundleIdentifier}.onesignal`;
-}
 exports.NSE_SOURCE_FILE = 'NotificationService.m';
+exports.NSE_PODFILE_SNIPPET = `
+target '${exports.NSE_TARGET_NAME}' do
+  pod 'OneSignalXCFramework', '>= 5.0', '< 6.0'
+  use_frameworks! :linkage => podfile_properties['ios.useFrameworks'].to_sym if podfile_properties['ios.useFrameworks']
+end`;
+exports.NSE_PODFILE_REGEX = new RegExp(`target '${exports.NSE_TARGET_NAME}'`);
 exports.NSE_EXT_FILES = [
     'NotificationService.h',
     `${exports.NSE_TARGET_NAME}.entitlements`,

package/build/support/updatePodfile.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updatePodfile = updatePodfile;
-const fs_1 = __importDefault(require("fs"));
+const promises_1 = __importDefault(require("fs/promises"));
 const iosConstants_1 = require("./iosConstants");
 const OneSignalLog_1 = require("./OneSignalLog");
 const FileManager_1 = require("./FileManager");
@@ -12,13 +12,9 @@ async function updatePodfile(iosPath) {
     const podfile = await FileManager_1.FileManager.readFile(`${iosPath}/Podfile`);
     const matches = podfile.match(iosConstants_1.NSE_PODFILE_REGEX);
     if (matches) {
-        OneSignalLog_1.OneSignalLog.log('OneSignalNotificationServiceExtension target already added to Podfile. Skipping...');
-    }
-    else {
-        fs_1.default.appendFile(`${iosPath}/Podfile`, iosConstants_1.NSE_PODFILE_SNIPPET, (err) => {
-            if (err) {
-                OneSignalLog_1.OneSignalLog.error('Error writing to Podfile');
-            }
-        });
+        OneSignalLog_1.OneSignalLog.log(`${iosConstants_1.NSE_TARGET_NAME} target already added to Podfile. Skipping...`);
+        return;
     }
+    await promises_1.default.appendFile(`${iosPath}/Podfile`, iosConstants_1.NSE_PODFILE_SNIPPET);
+    OneSignalLog_1.OneSignalLog.log(`${iosConstants_1.NSE_TARGET_NAME} target added to Podfile.`);
 }

package/build/types/types.js

@@ -10,6 +10,7 @@ exports.ONESIGNAL_PLUGIN_PROPS = [
     'iosNSEFilePath',
     'smallIconAccentColor',
     'appGroupName',
+    'nseBundleIdentifier',
 ];
 var Mode;
 (function (Mode) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Some Changez",
   "main": "./app.plugin.js",
   "files": [
@@ -47,6 +47,9 @@
     "prettier": "^3.8.1",
     "typescript": "^5.9.3"
   },
+  "peerDependencies": {
+    "react-native-onesignal": ">=5.0.0"
+  },
   "dependencies": {
     "@expo/image-utils": "^0.8.8"
   }