onesignal-expo-plugin 2.0.3 → 2.1.0

package/README.md

@@ -16,44 +16,40 @@
 
 > The OneSignal Expo plugin allows you to use OneSignal without leaving the managed workflow. Developed in collaboration with SweetGreen.
 
-* 🏠 [Homepage](https://github.com/OneSignal/onesignal-expo-plugin#readme)
-* 🖤 [npm](https://www.npmjs.com/package/onesignal-expo-plugin)
+- 🏠 [Homepage](https://github.com/OneSignal/onesignal-expo-plugin#readme)
+- 🖤 [npm](https://www.npmjs.com/package/onesignal-expo-plugin)
 
 ## Overview
+
 This plugin is an [Expo Config Plugin](https://docs.expo.dev/guides/config-plugins/). It extends the Expo config to allow customizing the prebuild phase of managed workflow builds (no need to eject to a bare workflow). For the purposes of OneSignal integration, the plugin facilitates automatically generating/configuring the necessary native code files needed to get the [OneSignal React-Native SDK](https://github.com/OneSignal/react-native-onesignal) to work. You can think of adding a plugin as adding custom native code.
 
 ## Supported environments:
-* [The Expo run commands](https://docs.expo.dev/workflow/customizing/) (`expo run:[android|ios]`)
-* [Custom clients](https://blog.expo.dev/introducing-custom-development-clients-5a2c79a9ddf8)
-* [EAS Build](https://docs.expo.dev/build/introduction/)
+
+- [The Expo run commands](https://docs.expo.dev/workflow/customizing/) (`expo run:[android|ios]`)
+- [Custom clients](https://blog.expo.dev/introducing-custom-development-clients-5a2c79a9ddf8)
+- [EAS Build](https://docs.expo.dev/build/introduction/)
 
 ---
 
 ## Install
-You need both the `onesignal-expo-plugin` *and* the `react-native-onesignal` npm package.
-
-```sh
-npx expo install onesignal-expo-plugin
-
-# npm
-npm install react-native-onesignal
 
-# yarn
-yarn add react-native-onesignal
-```
+See the [Setup Guide](https://documentation.onesignal.com/docs/en/react-native-expo-sdk-setup) for setup instructions.
 
 ## Configuration in app.json / app.config.js
+
 ### Plugin
+
 Add the plugin to the **front** of the [plugin array](https://docs.expo.dev/versions/latest/config/app/). It should be added automatically if you ran `npx expo install`. Just make sure it is the first plugin in the array and to configure any desired plugin props:
 
 **app.json**
+
 ```json
 {
   "plugins": [
     [
       "onesignal-expo-plugin",
       {
-        "mode": "development",
+        "mode": "development"
       }
     ]
   ]
@@ -63,6 +59,7 @@ Add the plugin to the **front** of the [plugin array](https://docs.expo.dev/vers
 or
 
 **app.config.js**
+
 ```js
 export default {
   ...
@@ -78,22 +75,26 @@ export default {
 ```
 
 #### Plugin Prop
+
 You can pass props to the plugin config object to configure:
 
-| Plugin Prop              |          |                                                                                                                                                                                                                                                                                                                                |
-|--------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `mode`                   | **required** | Used to configure  [APNs environment](https://developer.apple.com/documentation/bundleresources/entitlements/aps-environment)  entitlement.  `"development"` or  `"production"`                                                                                                                                            |
-| `devTeam`                | optional | Used to configure Apple Team ID. You can find your Apple Team ID by running `expo credentials:manager`  e.g: `"91SW8A37CR"`                                                                                                                                                                                                    |
-| `iPhoneDeploymentTarget` | optional | Target `IPHONEOS_DEPLOYMENT_TARGET` value to be used when adding the iOS [NSE](https://documentation.onesignal.com/docs/service-extensions). A deployment target is nothing more than the minimum version of the operating system the application can run on. This value should match the value in your Podfile e.g: `"12.0"`. |
-| `smallIcons`             | optional | An array of local paths to small notification icons for Android.  Image should be white, transparent, and 96x96 in size.  Input images will be automatically scaled down and placed in the appropriate resource folders.  e.g: `["./assets/ic_stat_onesignal_default.png"]`. See https://documentation.onesignal.com/docs/customize-notification-icons#small-notification-icons.  |
-| `largeIcons`             | optional | An array of local paths to large notification icons for Android.  Image should be white, transparent, and 256x256 in size.  e.g: `["./assets/ic_onesignal_large_icon_default.png"]`. See https://documentation.onesignal.com/docs/customize-notification-icons#large-notification-icons.                                                                                                |
-| `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"`. |
+| Plugin Prop              |              |                                                                                                                                                                                                                                                                                                                                                                               |
+| ------------------------ | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mode`                   | **required** | Used to configure [APNs environment](https://developer.apple.com/documentation/bundleresources/entitlements/aps-environment) entitlement. `"development"` or `"production"`                                                                                                                                                                                                   |
+| `devTeam`                | optional     | Used to configure Apple Team ID. You can find your Apple Team ID by running `expo credentials:manager` e.g: `"91SW8A37CR"`                                                                                                                                                                                                                                                    |
+| `iPhoneDeploymentTarget` | optional     | Target `IPHONEOS_DEPLOYMENT_TARGET` value to be used when adding the iOS [NSE](https://documentation.onesignal.com/docs/service-extensions). A deployment target is nothing more than the minimum version of the operating system the application can run on. This value should match the value in your Podfile e.g: `"12.0"`.                                                |
+| `smallIcons`             | optional     | An array of local paths to small notification icons for Android. Image should be white, transparent, and 96x96 in size. Input images will be automatically scaled down and placed in the appropriate resource folders. e.g: `["./assets/ic_stat_onesignal_default.png"]`. See https://documentation.onesignal.com/docs/customize-notification-icons#small-notification-icons. |
+| `largeIcons`             | optional     | An array of local paths to large notification icons for Android. Image should be white, transparent, and 256x256 in size. e.g: `["./assets/ic_onesignal_large_icon_default.png"]`. See https://documentation.onesignal.com/docs/customize-notification-icons#large-notification-icons.                                                                                        |
+| `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"`. |
 
 ### OneSignal App ID
+
 Add your OneSignal App ID to your [Expo constants via the `extra` param](https://docs.expo.dev/versions/latest/config/app/#extra):
 
 **Example:**
+
 ```json
 {
   "extra": {
@@ -105,7 +106,7 @@ Add your OneSignal App ID to your [Expo constants via the `extra` param](https:/
 You can then access the value to pass to the `initialize` function:
 
 ```js
-import { OneSignal } from 'react-native-onesignal';
+import { OneSignal } from "react-native-onesignal";
 import Constants from "expo-constants";
 OneSignal.initialize(Constants.expoConfig.extra.oneSignalAppId);
 ```
@@ -117,31 +118,37 @@ OneSignal.initialize("YOUR-ONESIGNAL-APP-ID");
 ```
 
 ### Versioning
+
 In your configuration file, make sure you set:
 
-| Property             | Details                                                                                                                                                                      |
-|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `version`         | Your app version. Corresponds to `CFBundleShortVersionString` on iOS. It is a human-readable version number of an iOS app, and is typically in the format of "X.X.X" (e.g. "1.0" or "2.3.1"). It is the version number that is typically displayed to users in the App Store and in the app itself. This value will be used in your NSE* target's plist file.                                               |
-| `ios.buildNumber` | Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's specified format (e.g: "42" or "100"). The build number is used by the App Store and iOS to identify and track different versions of an app, and is typically incremented for each new release. It is a number typically used for the developer's and system reference. This value will be used in your NSE* target's plist file. |
-| `ios.bundleIdentifier` | Bundle identifier for your iOS standalone app. Corresponds to `CFBundleIdentifier`. It's a unique identifier string that is used to identify an iOS app or bundle. It is typically in the format of `"com.companyname.appname"` (e.g. `"com.example.myapp"`). This value will be used in your NSE* target's plist and entitlements file.           |
+| Property               | Details                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `version`              | Your app version. Corresponds to `CFBundleShortVersionString` on iOS. It is a human-readable version number of an iOS app, and is typically in the format of "X.X.X" (e.g. "1.0" or "2.3.1"). It is the version number that is typically displayed to users in the App Store and in the app itself. This value will be used in your NSE\* target's plist file.                                                                       |
+| `ios.buildNumber`      | Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's specified format (e.g: "42" or "100"). The build number is used by the App Store and iOS to identify and track different versions of an app, and is typically incremented for each new release. It is a number typically used for the developer's and system reference. This value will be used in your NSE\* target's plist file. |
+| `ios.bundleIdentifier` | Bundle identifier for your iOS standalone app. Corresponds to `CFBundleIdentifier`. It's a unique identifier string that is used to identify an iOS app or bundle. It is typically in the format of `"com.companyname.appname"` (e.g. `"com.example.myapp"`). This value will be used in your NSE\* target's plist and entitlements file.                                                                                            |
 
 \* NSE = Notification Service Extension. Learn more about the NSE [here](https://documentation.onesignal.com/docs/service-extensions).
 
 ## EAS (Expo Application Services)
+
 See our [EAS documentation](EAS.md) for help with EAS.
 
 ### iOS Credentials: OneSignal + EAS
+
 To distribute your iOS application via EAS, you will need to ensure your credentials are set up correctly. See our [credentials setup guide for instructions](IOS_CREDENTIALS_EAS.md).
 
 ## Prebuild (optional)
+
 Prebuilding in Expo will result in the generation of the native runtime code for the project (and `ios` and `android` directories being built). By prebuilding, we automatically link and configure the native modules that have implemented CocoaPods, autolinking, and other config plugins. You can think of prebuild like a native code bundler.
 
 When you run `expo prebuild` we enter into a custom managed workflow which provides most of the benefits of bare workflows and managed workflows at the same time.
 
 #### Why should I prebuild?
+
 It may make sense to prebuild locally to inspect config plugin changes and help in debugging issues.
 
 #### Run
+
 ```sh
 npx expo prebuild
 ```
@@ -154,7 +161,9 @@ npx expo prebuild --clean
 **EAS Note:** if you choose to stay in a fully managed workflow by not prebuilding, EAS will still run `npx expo prebuild` at build time. You can also prebuild locally but remain in a fully managed workflow by adding the `android` and `ios` directories to your .gitignore.
 
 ## Run
-The following commands will prebuild *and* run your application. Note that for iOS, push notifications will **not** work in the Simulator.
+
+The following commands will prebuild _and_ run your application. Note that for iOS, push notifications will **not** work in the Simulator.
+
 ```sh
 # Build and run your native iOS project
 npx expo run:ios
@@ -175,10 +184,10 @@ Give a ⭐️ if this project helped you!
 
 ## OneSignal
 
-* Website: https://onesignal.com
-* Twitter: [@onesignal](https://twitter.com/onesignal)
-* Github: [@OneSignal](https://github.com/OneSignal)
-* LinkedIn: [@onesignal](https://linkedin.com/company/onesignal)
+- Website: https://onesignal.com
+- Twitter: [@onesignal](https://twitter.com/onesignal)
+- Github: [@OneSignal](https://github.com/OneSignal)
+- LinkedIn: [@onesignal](https://linkedin.com/company/onesignal)
 
 ## 📝 License
 

package/build/onesignal/withOneSignalAndroid.js

@@ -17,23 +17,21 @@ const SMALL_ICON_DIRS_TO_SIZE = {
     'drawable-hdpi': 36,
     'drawable-xhdpi': 48,
     'drawable-xxhdpi': 72,
-    'drawable-xxxhdpi': 96
+    'drawable-xxxhdpi': 96,
 };
 // The name of each large icon folder resource, and the icon size for that folder.
 const LARGE_ICON_DIRS_TO_SIZE = {
-    'drawable-xxxhdpi': 256
+    'drawable-xxxhdpi': 256,
 };
 const withSmallIcons = (config, onesignalProps) => {
-    var _a;
-    if (!onesignalProps.smallIcons && !((_a = config.notification) === null || _a === void 0 ? void 0 : _a.icon)) {
+    if (!onesignalProps.smallIcons && !config.notification?.icon) {
         return config;
     }
     // we are modifying the android build (adding files) without a base mod
     return (0, config_plugins_1.withDangerousMod)(config, [
         'android',
         async (config) => {
-            var _a;
-            if ((_a = config.notification) === null || _a === void 0 ? void 0 : _a.icon) {
+            if (config.notification?.icon) {
                 await saveIconAsync(config.notification.icon, config.modRequest.projectRoot, SMALL_ICON_DIRS_TO_SIZE);
             }
             if (onesignalProps.smallIcons) {
@@ -63,15 +61,11 @@ const withSmallIconAccentColor = (config, onesignalProps) => {
         return config;
     }
     return (0, config_plugins_1.withStringsXml)(config, (config) => {
-        var _a, _b;
-        const colorInARGB = `FF${(_a = onesignalProps.smallIconAccentColor) === null || _a === void 0 ? void 0 : _a.replace('#', '')}`;
-        const strings = (_b = config.modResults.resources.string) !== null && _b !== void 0 ? _b : [];
+        const colorInARGB = `FF${onesignalProps.smallIconAccentColor?.replace('#', '')}`;
+        const strings = config.modResults.resources.string ?? [];
         // Check if the accent color entry already exists
-        const hasAccentColor = strings.some((stringEntry) => {
-            var _a;
-            return ((_a = stringEntry.$) === null || _a === void 0 ? void 0 : _a.name) === 'onesignal_notification_accent_color' &&
-                stringEntry._ === colorInARGB;
-        });
+        const hasAccentColor = strings.some((stringEntry) => stringEntry.$?.name === 'onesignal_notification_accent_color' &&
+            stringEntry._ === colorInARGB);
         if (!hasAccentColor) {
             const accentColorEntry = {
                 $: { name: 'onesignal_notification_accent_color' },
@@ -89,7 +83,7 @@ async function saveIconsArrayAsync(projectRoot, icons, dirsToSize) {
 }
 async function saveIconAsync(icon, projectRoot, dirsToSize) {
     const name = (0, path_1.parse)(icon).name;
-    OneSignalLog_1.OneSignalLog.log("Saving icon " + icon + " as drawable resource " + name);
+    OneSignalLog_1.OneSignalLog.log('Saving icon ' + icon + ' as drawable resource ' + name);
     for (const iconResourceDir in dirsToSize) {
         const path = (0, path_1.resolve)(projectRoot, RESOURCE_ROOT_PATH, iconResourceDir);
         if (!(0, fs_1.existsSync)(path)) {

package/build/onesignal/withOneSignalIos.js

@@ -5,7 +5,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -15,13 +19,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -43,13 +57,13 @@ const getEasManagedCredentialsConfigExtra_1 = __importDefault(require("../suppor
  */
 const withAppEnvironment = (config, onesignalProps) => {
     return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
-        if ((onesignalProps === null || onesignalProps === void 0 ? void 0 : onesignalProps.mode) == null) {
+        if (onesignalProps?.mode == null) {
             throw new Error(`
         Missing required "mode" key in your app.json or app.config.js file for "onesignal-expo-plugin".
         "mode" can be either "development" or "production".
         Please see onesignal-expo-plugin's README.md for more details.`);
         }
-        newConfig.modResults["aps-environment"] = onesignalProps.mode;
+        newConfig.modResults['aps-environment'] = onesignalProps.mode;
         return newConfig;
     });
 };
@@ -58,7 +72,7 @@ const withAppEnvironment = (config, onesignalProps) => {
  * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
  */
 const withRemoteNotificationsPermissions = (config) => {
-    const BACKGROUND_MODE_KEYS = ["remote-notification"];
+    const BACKGROUND_MODE_KEYS = ['remote-notification'];
     return (0, config_plugins_1.withInfoPlist)(config, (newConfig) => {
         if (!Array.isArray(newConfig.modResults.UIBackgroundModes)) {
             newConfig.modResults.UIBackgroundModes = [];
@@ -75,15 +89,14 @@ const withRemoteNotificationsPermissions = (config) => {
  * Add "App Group" permission
  * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps (step 4.4)
  */
-const withAppGroupPermissions = (config) => {
-    const APP_GROUP_KEY = "com.apple.security.application-groups";
-    return (0, config_plugins_1.withEntitlementsPlist)(config, newConfig => {
-        var _a;
+const withAppGroupPermissions = (config, props) => {
+    const APP_GROUP_KEY = 'com.apple.security.application-groups';
+    return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
         if (!Array.isArray(newConfig.modResults[APP_GROUP_KEY])) {
             newConfig.modResults[APP_GROUP_KEY] = [];
         }
         const modResultsArray = newConfig.modResults[APP_GROUP_KEY];
-        const entitlement = `group.${((_a = newConfig === null || newConfig === void 0 ? void 0 : newConfig.ios) === null || _a === void 0 ? void 0 : _a.bundleIdentifier) || ""}.onesignal`;
+        const entitlement = (0, iosConstants_1.getAppGroupIdentifier)(newConfig?.ios?.bundleIdentifier || '', props?.appGroupName);
         if (modResultsArray.indexOf(entitlement) !== -1) {
             return newConfig;
         }
@@ -91,10 +104,21 @@ const withAppGroupPermissions = (config) => {
         return newConfig;
     });
 };
-const withEasManagedCredentials = (config) => {
-    var _a;
-    (0, assert_1.default)((_a = config.ios) === null || _a === void 0 ? void 0 : _a.bundleIdentifier, "Missing 'ios.bundleIdentifier' in app config.");
-    config.extra = (0, getEasManagedCredentialsConfigExtra_1.default)(config);
+/**
+ * Add OneSignal_app_groups_key to Info.plist when a custom app group name is provided.
+ * @see https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-create-an-app-group
+ */
+const withCustomAppGroupsKey = (config, props) => {
+    return (0, config_plugins_1.withInfoPlist)(config, (newConfig) => {
+        if (props?.appGroupName) {
+            newConfig.modResults.OneSignal_app_groups_key = props.appGroupName;
+        }
+        return newConfig;
+    });
+};
+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);
     return config;
 };
 const withOneSignalPodfile = (config) => {
@@ -102,21 +126,22 @@ const withOneSignalPodfile = (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); });
+            const iosRoot = path.join(config.modRequest.projectRoot, 'ios');
+            (0, updatePodfile_1.updatePodfile)(iosRoot).catch((err) => {
+                OneSignalLog_1.OneSignalLog.error(err);
+            });
             return config;
         },
     ]);
 };
 const withOneSignalNSE = (config, props) => {
     // support for monorepos where node_modules can be above the project directory.
-    const pluginDir = require.resolve("onesignal-expo-plugin/package.json");
-    const sourceDir = path.join(pluginDir, "../build/support/serviceExtensionFiles/");
+    const pluginDir = require.resolve('onesignal-expo-plugin/package.json');
+    const sourceDir = path.join(pluginDir, '../build/support/serviceExtensionFiles/');
     return (0, config_plugins_1.withDangerousMod)(config, [
         'ios',
         async (config) => {
-            var _a, _b, _c, _d, _e;
-            const iosPath = path.join(config.modRequest.projectRoot, "ios");
+            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++) {
@@ -125,23 +150,26 @@ const withOneSignalNSE = (config, props) => {
                 await FileManager_1.FileManager.copyFile(`${sourceDir}${extFile}`, targetFile);
             }
             // Copy NSE source file either from configuration-provided location, falling back to the default one.
-            const sourcePath = (_a = props.iosNSEFilePath) !== null && _a !== void 0 ? _a : `${sourceDir}${iosConstants_1.NSE_SOURCE_FILE}`;
+            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);
-            await nseUpdater.updateNSEEntitlements(`group.${(_b = config.ios) === null || _b === void 0 ? void 0 : _b.bundleIdentifier}.onesignal`);
-            await nseUpdater.updateNSEBundleVersion((_d = (_c = config.ios) === null || _c === void 0 ? void 0 : _c.buildNumber) !== null && _d !== void 0 ? _d : iosConstants_1.DEFAULT_BUNDLE_VERSION);
-            await nseUpdater.updateNSEBundleShortVersion((_e = config === null || config === void 0 ? void 0 : config.version) !== null && _e !== void 0 ? _e : iosConstants_1.DEFAULT_BUNDLE_SHORT_VERSION);
+            const appGroupId = (0, iosConstants_1.getAppGroupIdentifier)(config.ios?.bundleIdentifier ?? '', props.appGroupName);
+            await nseUpdater.updateNSEEntitlements(appGroupId);
+            if (props.appGroupName) {
+                await nseUpdater.updateNSEInfoPlistAppGroupKey(props.appGroupName);
+            }
+            await nseUpdater.updateNSEBundleVersion(config.ios?.buildNumber ?? iosConstants_1.DEFAULT_BUNDLE_VERSION);
+            await nseUpdater.updateNSEBundleShortVersion(config?.version ?? iosConstants_1.DEFAULT_BUNDLE_SHORT_VERSION);
             return config;
         },
     ]);
 };
 const withOneSignalXcodeProject = (config, props) => {
-    return (0, config_plugins_1.withXcodeProject)(config, newConfig => {
-        var _a, _b;
+    return (0, config_plugins_1.withXcodeProject)(config, (newConfig) => {
         const xcodeProject = newConfig.modResults;
-        if (!!xcodeProject.pbxTargetByName(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;
         }
@@ -149,9 +177,11 @@ const withOneSignalXcodeProject = (config, props) => {
         const extGroup = xcodeProject.addPbxGroup([...iosConstants_1.NSE_EXT_FILES, iosConstants_1.NSE_SOURCE_FILE], iosConstants_1.NSE_TARGET_NAME, iosConstants_1.NSE_TARGET_NAME);
         // Add the new PBXGroup to the top level group. This makes the
         // files / folder appear in the file explorer in Xcode.
-        const groups = xcodeProject.hash.project.objects["PBXGroup"];
+        const groups = xcodeProject.hash.project.objects['PBXGroup'];
         Object.keys(groups).forEach(function (key) {
-            if (typeof groups[key] === "object" && groups[key].name === undefined && groups[key].path === undefined) {
+            if (typeof groups[key] === 'object' &&
+                groups[key].name === undefined &&
+                groups[key].path === undefined) {
                 xcodeProject.addToPbxGroup(extGroup.uuid, key);
             }
         });
@@ -160,38 +190,42 @@ const withOneSignalXcodeProject = (config, props) => {
         // An upstream fix should be made to the code referenced in this link:
         //   - https://github.com/apache/cordova-node-xcode/blob/8b98cabc5978359db88dc9ff2d4c015cba40f150/lib/pbxProject.js#L860
         const projObjects = xcodeProject.hash.project.objects;
-        projObjects['PBXTargetDependency'] = projObjects['PBXTargetDependency'] || {};
-        projObjects['PBXContainerItemProxy'] = projObjects['PBXTargetDependency'] || {};
+        projObjects['PBXTargetDependency'] =
+            projObjects['PBXTargetDependency'] || {};
+        projObjects['PBXContainerItemProxy'] =
+            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, `${(_a = config.ios) === null || _a === void 0 ? void 0 : _a.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`);
+        const nseTarget = xcodeProject.addTarget(iosConstants_1.NSE_TARGET_NAME, 'app_extension', iosConstants_1.NSE_TARGET_NAME, `${config.ios?.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`);
         // Add build phases to the new target
-        xcodeProject.addBuildPhase(["NotificationService.m"], "PBXSourcesBuildPhase", "Sources", nseTarget.uuid);
-        xcodeProject.addBuildPhase([], "PBXResourcesBuildPhase", "Resources", nseTarget.uuid);
-        xcodeProject.addBuildPhase([], "PBXFrameworksBuildPhase", "Frameworks", nseTarget.uuid);
+        xcodeProject.addBuildPhase(['NotificationService.m'], 'PBXSourcesBuildPhase', 'Sources', nseTarget.uuid);
+        xcodeProject.addBuildPhase([], 'PBXResourcesBuildPhase', 'Resources', nseTarget.uuid);
+        xcodeProject.addBuildPhase([], 'PBXFrameworksBuildPhase', 'Frameworks', nseTarget.uuid);
         // Edit the Deployment info of the new Target, only IphoneOS and Targeted Device Family
         // However, can be more
         const configurations = xcodeProject.pbxXCBuildConfigurationSection();
         for (const key in configurations) {
-            if (typeof configurations[key].buildSettings !== "undefined" &&
+            if (typeof configurations[key].buildSettings !== 'undefined' &&
                 configurations[key].buildSettings.PRODUCT_NAME == `"${iosConstants_1.NSE_TARGET_NAME}"`) {
                 const buildSettingsObj = configurations[key].buildSettings;
-                buildSettingsObj.DEVELOPMENT_TEAM = props === null || props === void 0 ? void 0 : props.devTeam;
-                buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET = (_b = props === null || props === void 0 ? void 0 : props.iPhoneDeploymentTarget) !== null && _b !== void 0 ? _b : iosConstants_1.IPHONEOS_DEPLOYMENT_TARGET;
+                buildSettingsObj.DEVELOPMENT_TEAM = props?.devTeam;
+                buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET =
+                    props?.iPhoneDeploymentTarget ?? iosConstants_1.IPHONEOS_DEPLOYMENT_TARGET;
                 buildSettingsObj.TARGETED_DEVICE_FAMILY = iosConstants_1.TARGETED_DEVICE_FAMILY;
                 buildSettingsObj.CODE_SIGN_ENTITLEMENTS = `${iosConstants_1.NSE_TARGET_NAME}/${iosConstants_1.NSE_TARGET_NAME}.entitlements`;
-                buildSettingsObj.CODE_SIGN_STYLE = "Automatic";
+                buildSettingsObj.CODE_SIGN_STYLE = 'Automatic';
             }
         }
         // Add development teams to both your target and the original project
-        xcodeProject.addTargetAttribute("DevelopmentTeam", props === null || props === void 0 ? void 0 : props.devTeam, nseTarget);
-        xcodeProject.addTargetAttribute("DevelopmentTeam", props === null || props === void 0 ? void 0 : props.devTeam);
+        xcodeProject.addTargetAttribute('DevelopmentTeam', props?.devTeam, nseTarget);
+        xcodeProject.addTargetAttribute('DevelopmentTeam', props?.devTeam);
         return newConfig;
     });
 };
 const withOneSignalIos = (config, props) => {
     config = withAppEnvironment(config, props);
     config = withRemoteNotificationsPermissions(config, props);
+    config = withCustomAppGroupsKey(config, props);
     config = withAppGroupPermissions(config, props);
     config = withOneSignalPodfile(config, props);
     config = withOneSignalNSE(config, props);

package/build/support/FileManager.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -11,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileManager = void 0;
 const fs = __importStar(require("fs"));

package/build/support/NseUpdaterManager.js

@@ -6,8 +6,8 @@ const iosConstants_1 = require("./iosConstants");
 const entitlementsFileName = `OneSignalNotificationServiceExtension.entitlements`;
 const plistFileName = `OneSignalNotificationServiceExtension-Info.plist`;
 class NseUpdaterManager {
+    nsePath = '';
     constructor(iosPath) {
-        this.nsePath = '';
         this.nsePath = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`;
     }
     async updateNSEEntitlements(groupIdentifier) {
@@ -28,5 +28,12 @@ class NseUpdaterManager {
         plistFile = plistFile.replace(iosConstants_1.BUNDLE_SHORT_VERSION_TEMPLATE_REGEX, version);
         await FileManager_1.FileManager.writeFile(plistFilePath, plistFile);
     }
+    async updateNSEInfoPlistAppGroupKey(appGroupName) {
+        const plistFilePath = `${this.nsePath}/${plistFileName}`;
+        let plistFile = await FileManager_1.FileManager.readFile(plistFilePath);
+        const appGroupEntry = `\t<key>OneSignal_app_groups_key</key>\n\t<string>${appGroupName}</string>\n</dict>\n</plist>`;
+        plistFile = plistFile.replace('</dict>\n</plist>', appGroupEntry);
+        await FileManager_1.FileManager.writeFile(plistFilePath, plistFile);
+    }
 }
 exports.default = NseUpdaterManager;

package/build/support/eas/getEasManagedCredentialsConfigExtra.js

@@ -1,35 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getEasManagedCredentialsConfigExtra;
 const iosConstants_1 = require("../iosConstants");
-function getEasManagedCredentialsConfigExtra(config) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+function getEasManagedCredentialsConfigExtra(config, appGroupName) {
     return {
         ...config.extra,
         eas: {
-            ...(_a = config.extra) === null || _a === void 0 ? void 0 : _a.eas,
+            ...config.extra?.eas,
             build: {
-                ...(_c = (_b = config.extra) === null || _b === void 0 ? void 0 : _b.eas) === null || _c === void 0 ? void 0 : _c.build,
+                ...config.extra?.eas?.build,
                 experimental: {
-                    ...(_f = (_e = (_d = config.extra) === null || _d === void 0 ? void 0 : _d.eas) === null || _e === void 0 ? void 0 : _e.build) === null || _f === void 0 ? void 0 : _f.experimental,
+                    ...config.extra?.eas?.build?.experimental,
                     ios: {
-                        ...(_k = (_j = (_h = (_g = config.extra) === null || _g === void 0 ? void 0 : _g.eas) === null || _h === void 0 ? void 0 : _h.build) === null || _j === void 0 ? void 0 : _j.experimental) === null || _k === void 0 ? void 0 : _k.ios,
+                        ...config.extra?.eas?.build?.experimental?.ios,
                         appExtensions: [
-                            ...((_r = (_q = (_p = (_o = (_m = (_l = config.extra) === null || _l === void 0 ? void 0 : _l.eas) === null || _m === void 0 ? void 0 : _m.build) === null || _o === void 0 ? void 0 : _o.experimental) === null || _p === void 0 ? void 0 : _p.ios) === null || _q === void 0 ? void 0 : _q.appExtensions) !== null && _r !== void 0 ? _r : []),
+                            ...(config.extra?.eas?.build?.experimental?.ios?.appExtensions ??
+                                []),
                             {
                                 // keep in sync with native changes in NSE
                                 targetName: iosConstants_1.NSE_TARGET_NAME,
-                                bundleIdentifier: `${(_s = config === null || config === void 0 ? void 0 : config.ios) === null || _s === void 0 ? void 0 : _s.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`,
+                                bundleIdentifier: `${config?.ios?.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`,
                                 entitlements: {
                                     'com.apple.security.application-groups': [
-                                        `group.${(_t = config === null || config === void 0 ? void 0 : config.ios) === null || _t === void 0 ? void 0 : _t.bundleIdentifier}.onesignal`
-                                    ]
+                                        (0, iosConstants_1.getAppGroupIdentifier)(config?.ios?.bundleIdentifier ?? '', appGroupName),
+                                    ],
                                 },
-                            }
-                        ]
-                    }
-                }
-            }
-        }
+                            },
+                        ],
+                    },
+                },
+            },
+        },
     };
 }
-exports.default = getEasManagedCredentialsConfigExtra;