onesignal-expo-plugin 1.0.0-beta4 → 1.0.0-beta8

package/LICENSE

@@ -0,0 +1,24 @@
+Modified MIT License
+
+Copyright 2021 OneSignal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+2. All copies of substantial portions of the Software may only be used in connection
+with services provided by OneSignal.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,15 +1,12 @@
 <h1 align="center">Welcome to onesignal-expo-plugin 👋</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0--beta1-blue.svg?cacheSeconds=2592000" />
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0--beta7-blue.svg?cacheSeconds=2592000" />
   <a href="https://github.com/OneSignal/onesignal-expo-plugin#readme" target="_blank">
     <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
   </a>
   <a href="https://github.com/OneSignal/onesignal-expo-plugin/graphs/commit-activity" target="_blank">
     <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
   </a>
-  <a href="https://github.com/OneSignal/onesignal-expo-plugin/blob/master/LICENSE" target="_blank">
-    <img alt="License: MIT" src="https://img.shields.io/github/license/OneSignal/onesignal-expo-plugin" />
-  </a>
   <a href="https://twitter.com/onesignal" target="_blank">
     <img alt="Twitter: onesignal" src="https://img.shields.io/twitter/follow/onesignal.svg?style=social" />
   </a>
@@ -17,7 +14,19 @@
 
 > 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)
+* 🏠 [Homepage](https://github.com/OneSignal/onesignal-expo-plugin#readme)
+* 🖤 [npm](https://www.npmjs.com/package/onesignal-expo-plugin)
+
+## 🚧 In Beta 🚧
+## 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/)
+
+---
 
 ## Install
 
@@ -25,20 +34,49 @@
 expo install onesignal-expo-plugin
 ```
 
-**Note:** this does not install the [OneSignal SDK](https://github.com/OneSignal/react-native-onesignal).
-
 ## Configuration in app.json / app.config.js
 ### Plugin
-Add the `withOneSignal.js` file to the [plugin array](https://docs.expo.dev/versions/latest/config/app/):
+Add the plugin to the [plugin array](https://docs.expo.dev/versions/latest/config/app/):
 
+**app.json**
 ```json
 {
   "plugins": [
-    "onesignal-expo-plugin"
+    [
+      "onesignal-expo-plugin",
+      {
+        "mode": "development",
+        "devTeam": "91SW8A37CR"
+      }
+    ]
   ]
 }
 ```
 
+or
+
+**app.config.js**
+```js
+export default {
+  ...
+  plugins: [
+    [
+      "onesignal-expo-plugin",
+      {
+        mode: process.env.NODE_ENV || "development",
+        devTeam: "91SW8A37CR"
+      }
+    ]
+  ]
+};
+```
+
+#### Plugin Options
+* `mode`: used to configure [APNs environment](https://developer.apple.com/documentation/bundleresources/entitlements/aps-environment) entitlement.
+   - `"development"`
+   - `"production"`
+* `devTeam`: *optional* - used to configure Apple Team ID. You can find your Apple Team ID by running `expo credentials:manager`.
+
 ### OneSignal App ID
 Add your OneSignal App ID to your [Expo constants via the `extra` param](https://docs.expo.dev/versions/latest/config/app/):
 
@@ -54,10 +92,28 @@ Add your OneSignal App ID to your [Expo constants via the `extra` param](https:/
 You can then access the value to pass to the `setAppId` function:
 
 ```js
+import OneSignal from 'react-native-onesignal';
 import Constants from "expo-constants";
 OneSignal.setAppId(Constants.manifest.extra.oneSignalAppId);
 ```
 
+Alternatively, pass the app ID directly to the function:
+
+```js
+OneSignal.setAppId("YOUR-ONESIGNAL-APP-ID");
+```
+
+## Run
+```sh
+$ expo prebuild
+
+# Build your native iOS project
+$ expo run:ios
+
+# Build your native Android project
+$ expo run:android
+```
+
 ---
 
 ## 🤝 Contributing
@@ -78,4 +134,4 @@ Give a ⭐️ if this project helped you!
 ## 📝 License
 
 Copyright © 2021 [OneSignal](https://github.com/OneSignal).<br />
-This project is [MIT](https://github.com/OneSignal/onesignal-expo-plugin/blob/master/LICENSE) licensed.
+This project is [MIT](https://github.com/OneSignal/onesignal-expo-plugin/blob/main/LICENSE) licensed.

package/build/onesignal/withOneSignalIos.js

@@ -3,17 +3,31 @@
  * Expo config plugin for One Signal (iOS)
  * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withOneSignalIos = void 0;
+exports.xcodeProjectAddNse = exports.withOneSignalIos = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
+const fs_1 = __importDefault(require("fs"));
+const xcode_1 = __importDefault(require("xcode"));
+const iosConstants_1 = require("../support/iosConstants");
+const updatePodfile_1 = require("../support/updatePodfile");
+const updateNSEEntitlements_1 = require("../support/updateNSEEntitlements");
 // ---------- ---------- ---------- ----------
 /**
  * Add 'app-environment' record with current environment to '<project-name>.entitlements' file
  * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
  */
-const withAppEnvironment = (config, { mode }) => {
+const withAppEnvironment = (config, onesignalProps) => {
     return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
-        newConfig.modResults["aps-environment"] = mode;
+        if ((onesignalProps === null || onesignalProps === void 0 ? void 0 : 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;
         return newConfig;
     });
 };
@@ -22,7 +36,7 @@ const withAppEnvironment = (config, { mode }) => {
  * @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 = ["external-accessory", "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 = [];
@@ -50,11 +64,96 @@ const withAppGroupPermissions = (config) => {
         return newConfig;
     });
 };
+const withOneSignalNSE = (config, onesignalProps) => {
+    return (0, config_plugins_1.withXcodeProject)(config, async (props) => {
+        var _a;
+        xcodeProjectAddNse(props.modRequest.projectName || "", props.modRequest.platformProjectRoot, ((_a = props.ios) === null || _a === void 0 ? void 0 : _a.bundleIdentifier) || "", onesignalProps === null || onesignalProps === void 0 ? void 0 : onesignalProps.devTeam, "node_modules/onesignal-expo-plugin/build/support/serviceExtensionFiles/");
+        return props;
+    });
+};
 // ---------- ---------- ---------- ----------
 const withOneSignalIos = (config, props) => {
     withAppEnvironment(config, props);
     withRemoteNotificationsPermissions(config, props);
     withAppGroupPermissions(config, props);
+    withOneSignalNSE(config, props);
     return config;
 };
 exports.withOneSignalIos = withOneSignalIos;
+function xcodeProjectAddNse(appName, iosPath, bundleIdentifier, devTeam, sourceDir) {
+    (0, updatePodfile_1.updatePodfile)(iosPath);
+    (0, updateNSEEntitlements_1.updateNSEEntitlements)(`group.${bundleIdentifier}.onesignal`);
+    const projPath = `${iosPath}/${appName}.xcodeproj/project.pbxproj`;
+    const targetName = "OneSignalNotificationServiceExtension";
+    const extFiles = [
+        "NotificationService.h",
+        "NotificationService.m",
+        `${targetName}.entitlements`,
+        `${targetName}-Info.plist`
+    ];
+    const xcodeProject = xcode_1.default.project(projPath);
+    xcodeProject.parse(function (err) {
+        if (err) {
+            console.log(`Error parsing iOS project: ${JSON.stringify(err)}`);
+            return;
+        }
+        // Copy in the extension files
+        fs_1.default.mkdirSync(`${iosPath}/${targetName}`, { recursive: true });
+        extFiles.forEach(function (extFile) {
+            let targetFile = `${iosPath}/${targetName}/${extFile}`;
+            try {
+                fs_1.default.createReadStream(`${sourceDir}${extFile}`).pipe(fs_1.default.createWriteStream(targetFile));
+            }
+            catch (err) {
+                console.log(err);
+            }
+        });
+        const projObjects = xcodeProject.hash.project.objects;
+        // Create new PBXGroup for the extension
+        let extGroup = xcodeProject.addPbxGroup(extFiles, targetName, targetName);
+        // Add the new PBXGroup to the top level group. This makes the
+        // files / folder appear in the file explorer in Xcode.
+        let groups = xcodeProject.hash.project.objects["PBXGroup"];
+        Object.keys(groups).forEach(function (key) {
+            if (groups[key].name === undefined) {
+                xcodeProject.addToPbxGroup(extGroup.uuid, key);
+            }
+        });
+        // WORK AROUND for codeProject.addTarget BUG
+        // Xcode projects don't contain these if there is only one target
+        // 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
+        projObjects['PBXTargetDependency'] = projObjects['PBXTargetDependency'] || {};
+        projObjects['PBXContainerItemProxy'] = projObjects['PBXTargetDependency'] || {};
+        if (!!xcodeProject.pbxTargetByName(targetName)) {
+            console.log(targetName, "already exists in project. Skipping...");
+            return;
+        }
+        // Add the NSE target
+        // This adds PBXTargetDependency and PBXContainerItemProxy for you
+        const nseTarget = xcodeProject.addTarget(targetName, "app_extension", targetName, `${bundleIdentifier}.${targetName}`);
+        // 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);
+        // Edit the Deployment info of the new Target, only IphoneOS and Targeted Device Family
+        // However, can be more
+        let configurations = xcodeProject.pbxXCBuildConfigurationSection();
+        for (let key in configurations) {
+            if (typeof configurations[key].buildSettings !== "undefined" &&
+                configurations[key].buildSettings.PRODUCT_NAME == `"${targetName}"`) {
+                let buildSettingsObj = configurations[key].buildSettings;
+                buildSettingsObj.DEVELOPMENT_TEAM = devTeam;
+                buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET = iosConstants_1.IPHONEOS_DEPLOYMENT_TARGET;
+                buildSettingsObj.TARGETED_DEVICE_FAMILY = iosConstants_1.TARGETED_DEVICE_FAMILY;
+                buildSettingsObj.CODE_SIGN_ENTITLEMENTS = `${targetName}/${targetName}.entitlements`;
+                buildSettingsObj.CODE_SIGN_STYLE = "Automatic";
+            }
+        }
+        // Add development teams to both your target and the original project
+        xcodeProject.addTargetAttribute("DevelopmentTeam", devTeam, nseTarget);
+        xcodeProject.addTargetAttribute("DevelopmentTeam", devTeam);
+        fs_1.default.writeFileSync(projPath, xcodeProject.writeSync());
+    });
+}
+exports.xcodeProjectAddNse = xcodeProjectAddNse;

package/build/support/ReaderManager.js

@@ -0,0 +1,40 @@
+"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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReaderManager = void 0;
+const fs = __importStar(require("fs"));
+class ReaderManager {
+    static async readFile(path, replace) {
+        return new Promise((resolve, reject) => {
+            fs.readFile(path, 'utf8', (err, data) => {
+                if (err) {
+                    reject(err);
+                }
+                if (!data) {
+                    console.error("Couldn't read file:", path);
+                    return;
+                }
+                resolve(data);
+            });
+        });
+    }
+}
+exports.ReaderManager = ReaderManager;

package/build/support/iosConstants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GROUP_IDENTIFIER_TEMPLATE_REGEX = exports.NSE_PODFILE_REGEX = exports.NSE_PODFILE_SNIPPET = exports.TARGETED_DEVICE_FAMILY = exports.IPHONEOS_DEPLOYMENT_TARGET = void 0;
+exports.IPHONEOS_DEPLOYMENT_TARGET = "10.0";
+exports.TARGETED_DEVICE_FAMILY = `\"1,2\"`;
+exports.NSE_PODFILE_SNIPPET = `
+target 'OneSignalNotificationServiceExtension' do
+  pod 'OneSignalXCFramework', '>= 3.0', '< 4.0'
+end`;
+exports.NSE_PODFILE_REGEX = /target 'OneSignalNotificationServiceExtension'/;
+exports.GROUP_IDENTIFIER_TEMPLATE_REGEX = /{{GROUP_IDENTIFIER}}/gm;

package/build/support/serviceExtensionFiles/NotificationService.h

@@ -0,0 +1,8 @@
+//  NotificationService.h
+//  OneSignalNotificationServiceExtension
+
+#import <UserNotifications/UserNotifications.h>
+
+@interface NotificationService : UNNotificationServiceExtension
+
+@end

package/build/support/serviceExtensionFiles/NotificationService.m

@@ -0,0 +1,29 @@
+#import <OneSignal/OneSignal.h>
+
+#import "NotificationService.h"
+
+@interface NotificationService ()
+
+@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
+@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
+@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;
+
+@end
+
+@implementation NotificationService
+
+- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
+    self.receivedRequest = request;
+    self.contentHandler = contentHandler;
+    self.bestAttemptContent = [request.content mutableCopy];
+    [OneSignal didReceiveNotificationExtensionRequest:self.receivedRequest
+                       withMutableNotificationContent:self.bestAttemptContent
+                                   withContentHandler:self.contentHandler];
+}
+
+- (void)serviceExtensionTimeWillExpire {
+    [OneSignal serviceExtensionTimeWillExpireRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];
+    self.contentHandler(self.bestAttemptContent);
+}
+
+@end

package/build/support/serviceExtensionFiles/OneSignalNotificationServiceExtension-Info.plist

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleDisplayName</key>
+	<string>OneSignalNotificationServiceExtension</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.usernotifications.service</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>NotificationService</string>
+	</dict>
+</dict>
+</plist>

package/build/support/serviceExtensionFiles/OneSignalNotificationServiceExtension.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>{{GROUP_IDENTIFIER}}</string>
+	</array>
+</dict>
+</plist>

package/build/support/updateNSEEntitlements.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateNSEEntitlements = void 0;
+const fs_1 = __importDefault(require("fs"));
+const iosConstants_1 = require("./iosConstants");
+const ReaderManager_1 = require("./ReaderManager");
+const fileToEdit = `${__dirname}/serviceExtensionFiles/OneSignalNotificationServiceExtension.entitlements`;
+async function updateNSEEntitlements(groupIdentifier) {
+    let entitlementsFile = await ReaderManager_1.ReaderManager.readFile(fileToEdit);
+    entitlementsFile = entitlementsFile.replace(iosConstants_1.GROUP_IDENTIFIER_TEMPLATE_REGEX, groupIdentifier);
+    fs_1.default.writeFile(fileToEdit, entitlementsFile, 'utf-8', (err) => {
+        if (err) {
+            console.error("Error updating OneSignal NSE Entitlement File.");
+        }
+    });
+}
+exports.updateNSEEntitlements = updateNSEEntitlements;

package/build/support/updatePodfile.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatePodfile = void 0;
+const fs_1 = __importDefault(require("fs"));
+const iosConstants_1 = require("./iosConstants");
+const ReaderManager_1 = require("./ReaderManager");
+async function updatePodfile(iosPath) {
+    const podfile = await ReaderManager_1.ReaderManager.readFile(`${iosPath}/Podfile`);
+    const matches = podfile.match(iosConstants_1.NSE_PODFILE_REGEX);
+    if (matches) {
+        console.info("OneSignalNotificationServiceExtension target already added to Podfile. Skipping...");
+    }
+    else {
+        fs_1.default.appendFile(`${iosPath}/Podfile`, iosConstants_1.NSE_PODFILE_SNIPPET, (err) => {
+            if (err) {
+                console.error("Error writing to Podfile");
+            }
+        });
+    }
+}
+exports.updatePodfile = updatePodfile;

package/build/testRuniOS.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const withOneSignalIos_1 = require("./onesignal/withOneSignalIos");
+// Quick testing on any Xcode project
+// 1. Update values for your project
+// 2. Run `yarn build` from here
+// 3. Open a terminal to the root of your Xcode project
+// 4. Run `node ~/WHERE_YOU_CLONED_ME/onesignal-expo-plugin/build/testRuniOS.js`
+// 5. Run `pod init`, if you haven't already.
+//    - Make sure you are testing with 2 targets in your Podfile, your main target AND your NSE
+//    - If you forget your main target in your Podfile you will get the
+//     "Please add the host targets for the embedded targets to the Podfile." error
+//      even if your .xcodeproj is correct.
+(0, withOneSignalIos_1.xcodeProjectAddNse)("XcodeTestProj", ".", "com.onesignal.XcodeTestProj", "99SW8E36CT", "../../repos/onesignal-expo-plugin/support/serviceExtensionFiles/");

package/onesignal/withOneSignal.ts

@@ -13,6 +13,7 @@ export type OneSignalPluginProps = {
    */
   mode: string;
   iOsBundleIdentifier: string;
+  devTeam: string;
 };
 
 const withOneSignal: ConfigPlugin<OneSignalPluginProps> = (config, props) => {

package/onesignal/withOneSignalIos.ts

@@ -7,8 +7,14 @@ import {
   ConfigPlugin,
   withEntitlementsPlist,
   withInfoPlist,
+  withXcodeProject,
 } from "@expo/config-plugins";
 import { OneSignalPluginProps } from "./withOneSignal";
+import fs from 'fs';
+import xcode from 'xcode';
+import { IPHONEOS_DEPLOYMENT_TARGET, TARGETED_DEVICE_FAMILY } from "../support/iosConstants";
+import { updatePodfile } from "../support/updatePodfile";
+import { updateNSEEntitlements } from "../support/updateNSEEntitlements";
 
 // ---------- ---------- ---------- ----------
 
@@ -18,10 +24,17 @@ import { OneSignalPluginProps } from "./withOneSignal";
  */
 const withAppEnvironment: ConfigPlugin<OneSignalPluginProps> = (
   config,
-  { mode }
+  onesignalProps
 ) => {
   return withEntitlementsPlist(config, (newConfig) => {
-    newConfig.modResults["aps-environment"] = mode;
+    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;
     return newConfig;
   });
 };
@@ -33,7 +46,7 @@ const withAppEnvironment: ConfigPlugin<OneSignalPluginProps> = (
 const withRemoteNotificationsPermissions: ConfigPlugin<OneSignalPluginProps> = (
   config
 ) => {
-  const BACKGROUND_MODE_KEYS = ["external-accessory", "remote-notification"];
+  const BACKGROUND_MODE_KEYS = ["remote-notification"];
   return withInfoPlist(config, (newConfig) => {
     if (!Array.isArray(newConfig.modResults.UIBackgroundModes)) {
       newConfig.modResults.UIBackgroundModes = [];
@@ -68,6 +81,20 @@ const withAppGroupPermissions: ConfigPlugin<OneSignalPluginProps> = (
   });
 };
 
+const withOneSignalNSE: ConfigPlugin<OneSignalPluginProps> = (config, onesignalProps) => {
+  return withXcodeProject(config, async props => {
+    xcodeProjectAddNse(
+      props.modRequest.projectName || "",
+      props.modRequest.platformProjectRoot,
+      props.ios?.bundleIdentifier || "",
+      onesignalProps?.devTeam,
+      "node_modules/onesignal-expo-plugin/build/support/serviceExtensionFiles/"
+    );
+
+    return props;
+  });
+}
+
 // ---------- ---------- ---------- ----------
 export const withOneSignalIos: ConfigPlugin<OneSignalPluginProps> = (
   config,
@@ -76,6 +103,120 @@ export const withOneSignalIos: ConfigPlugin<OneSignalPluginProps> = (
   withAppEnvironment(config, props);
   withRemoteNotificationsPermissions(config, props);
   withAppGroupPermissions(config, props);
-
+  withOneSignalNSE(config, props);
   return config;
 };
+
+
+export function xcodeProjectAddNse(
+  appName: string,
+  iosPath: string,
+  bundleIdentifier: string,
+  devTeam: string | undefined,
+  sourceDir: string
+): void {
+  updatePodfile(iosPath);
+  updateNSEEntitlements(`group.${bundleIdentifier}.onesignal`)
+
+  const projPath = `${iosPath}/${appName}.xcodeproj/project.pbxproj`;
+  const targetName = "OneSignalNotificationServiceExtension";
+
+  const extFiles = [
+    "NotificationService.h",
+    "NotificationService.m",
+    `${targetName}.entitlements`,
+    `${targetName}-Info.plist`
+  ];
+
+  const xcodeProject = xcode.project(projPath);
+
+  xcodeProject.parse(function(err: Error) {
+    if (err) {
+      console.log(`Error parsing iOS project: ${JSON.stringify(err)}`);
+      return;
+    }
+
+    // Copy in the extension files
+    fs.mkdirSync(`${iosPath}/${targetName}`, { recursive: true });
+    extFiles.forEach(function (extFile) {
+      let targetFile = `${iosPath}/${targetName}/${extFile}`;
+
+      try {
+        fs.createReadStream(`${sourceDir}${extFile}`).pipe(
+          fs.createWriteStream(targetFile)
+        );
+      } catch (err) {
+        console.log(err);
+      }
+    });
+
+    const projObjects = xcodeProject.hash.project.objects;
+
+    // Create new PBXGroup for the extension
+    let extGroup = xcodeProject.addPbxGroup(extFiles, targetName, targetName);
+
+    // Add the new PBXGroup to the top level group. This makes the
+    // files / folder appear in the file explorer in Xcode.
+    let groups = xcodeProject.hash.project.objects["PBXGroup"];
+    Object.keys(groups).forEach(function (key) {
+      if (groups[key].name === undefined) {
+        xcodeProject.addToPbxGroup(extGroup.uuid, key);
+      }
+    });
+
+    // WORK AROUND for codeProject.addTarget BUG
+    // Xcode projects don't contain these if there is only one target
+    // 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
+    projObjects['PBXTargetDependency'] = projObjects['PBXTargetDependency'] || {};
+    projObjects['PBXContainerItemProxy'] = projObjects['PBXTargetDependency'] || {};
+
+    if (!!xcodeProject.pbxTargetByName(targetName)) {
+      console.log(targetName, "already exists in project. Skipping...");
+      return;
+    }
+
+    // Add the NSE target
+    // This adds PBXTargetDependency and PBXContainerItemProxy for you
+    const nseTarget = xcodeProject.addTarget(targetName, "app_extension", targetName, `${bundleIdentifier}.${targetName}`);
+
+    // 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
+    );
+
+    // Edit the Deployment info of the new Target, only IphoneOS and Targeted Device Family
+    // However, can be more
+    let configurations = xcodeProject.pbxXCBuildConfigurationSection();
+    for (let key in configurations) {
+      if (
+        typeof configurations[key].buildSettings !== "undefined" &&
+        configurations[key].buildSettings.PRODUCT_NAME == `"${targetName}"`
+      ) {
+        let buildSettingsObj = configurations[key].buildSettings;
+        buildSettingsObj.DEVELOPMENT_TEAM = devTeam;
+        buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET = IPHONEOS_DEPLOYMENT_TARGET;
+        buildSettingsObj.TARGETED_DEVICE_FAMILY = TARGETED_DEVICE_FAMILY;
+        buildSettingsObj.CODE_SIGN_ENTITLEMENTS = `${targetName}/${targetName}.entitlements`;
+        buildSettingsObj.CODE_SIGN_STYLE = "Automatic";
+      }
+    }
+
+    // Add development teams to both your target and the original project
+    xcodeProject.addTargetAttribute("DevelopmentTeam", devTeam, nseTarget);
+    xcodeProject.addTargetAttribute("DevelopmentTeam", devTeam);
+
+    fs.writeFileSync(projPath, xcodeProject.writeSync());
+  })
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "1.0.0-beta4",
+  "version": "1.0.0-beta8",
   "description": "The OneSignal Expo plugin allows you to use OneSignal without leaving the managed workflow. Developed in collaboration with SweetGreen.",
-  "main": "build/withOneSignal.js",
+  "main": "./app.plugin.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
+    "build": "rm -rf build && tsc && cp -a support/serviceExtensionFiles build/support/",
     "prepare": "yarn run build"
   },
   "repository": {
@@ -34,5 +34,8 @@
     "expo-module-scripts": "^2.0.0",
     "readme-md-generator": "^1.0.0"
   },
-  "dependencies": {}
+  "dependencies": {
+    "react-native-onesignal": "^4.3.1",
+    "xcode": "^3.0.1"
+  }
 }

package/support/ReaderManager.ts

@@ -0,0 +1,18 @@
+import * as fs from 'fs';
+
+export class ReaderManager {
+  static async readFile(path: string, replace?: string): Promise<string> {
+    return new Promise<string>((resolve, reject) => {
+      fs.readFile(path, 'utf8', (err, data) => {
+        if (err) {
+          reject(err);
+        }
+        if (!data) {
+          console.error("Couldn't read file:", path);
+          return;
+        }
+        resolve(data);
+      });
+    });
+  }
+}

package/support/iosConstants.ts

@@ -0,0 +1,11 @@
+export const IPHONEOS_DEPLOYMENT_TARGET = "10.0";
+export const TARGETED_DEVICE_FAMILY = `\"1,2\"`;
+
+export const NSE_PODFILE_SNIPPET = `
+target 'OneSignalNotificationServiceExtension' do
+  pod 'OneSignalXCFramework', '>= 3.0', '< 4.0'
+end`;
+
+export const NSE_PODFILE_REGEX = /target 'OneSignalNotificationServiceExtension'/;
+
+export const GROUP_IDENTIFIER_TEMPLATE_REGEX = /{{GROUP_IDENTIFIER}}/gm;

package/support/serviceExtensionFiles/NotificationService.h

@@ -0,0 +1,8 @@
+//  NotificationService.h
+//  OneSignalNotificationServiceExtension
+
+#import <UserNotifications/UserNotifications.h>
+
+@interface NotificationService : UNNotificationServiceExtension
+
+@end

package/support/serviceExtensionFiles/NotificationService.m

@@ -0,0 +1,29 @@
+#import <OneSignal/OneSignal.h>
+
+#import "NotificationService.h"
+
+@interface NotificationService ()
+
+@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
+@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
+@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;
+
+@end
+
+@implementation NotificationService
+
+- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
+    self.receivedRequest = request;
+    self.contentHandler = contentHandler;
+    self.bestAttemptContent = [request.content mutableCopy];
+    [OneSignal didReceiveNotificationExtensionRequest:self.receivedRequest
+                       withMutableNotificationContent:self.bestAttemptContent
+                                   withContentHandler:self.contentHandler];
+}
+
+- (void)serviceExtensionTimeWillExpire {
+    [OneSignal serviceExtensionTimeWillExpireRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];
+    self.contentHandler(self.bestAttemptContent);
+}
+
+@end

package/support/serviceExtensionFiles/OneSignalNotificationServiceExtension-Info.plist

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleDisplayName</key>
+	<string>OneSignalNotificationServiceExtension</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.usernotifications.service</string>
+		<key>NSExtensionPrincipalClass</key>
+		<string>NotificationService</string>
+	</dict>
+</dict>
+</plist>

package/support/serviceExtensionFiles/OneSignalNotificationServiceExtension.entitlements

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>com.apple.security.application-groups</key>
+	<array>
+		<string>{{GROUP_IDENTIFIER}}</string>
+	</array>
+</dict>
+</plist>

package/support/updateNSEEntitlements.ts

@@ -0,0 +1,16 @@
+import fs from 'fs';
+import { GROUP_IDENTIFIER_TEMPLATE_REGEX } from './iosConstants';
+import { ReaderManager } from './ReaderManager';
+
+const fileToEdit =`${__dirname}/serviceExtensionFiles/OneSignalNotificationServiceExtension.entitlements`;
+
+export async function updateNSEEntitlements(groupIdentifier: string) {
+  let entitlementsFile = await ReaderManager.readFile(fileToEdit);
+  entitlementsFile = entitlementsFile.replace(GROUP_IDENTIFIER_TEMPLATE_REGEX, groupIdentifier);
+
+  fs.writeFile(fileToEdit, entitlementsFile, 'utf-8', (err) => {
+    if (err) {
+      console.error("Error updating OneSignal NSE Entitlement File.");
+    }
+  })
+}

package/support/updatePodfile.ts

@@ -0,0 +1,18 @@
+import fs from 'fs';
+import { NSE_PODFILE_REGEX, NSE_PODFILE_SNIPPET } from './iosConstants';
+import { ReaderManager } from './ReaderManager';
+
+export async function updatePodfile(iosPath: string) {
+  const podfile = await ReaderManager.readFile(`${iosPath}/Podfile`);
+  const matches = podfile.match(NSE_PODFILE_REGEX);
+
+  if (matches) {
+    console.info("OneSignalNotificationServiceExtension target already added to Podfile. Skipping...");
+  } else {
+    fs.appendFile(`${iosPath}/Podfile`, NSE_PODFILE_SNIPPET, (err) => {
+      if (err) {
+        console.error("Error writing to Podfile");
+      }
+    })
+  }
+}

package/testRuniOS.ts

@@ -0,0 +1,20 @@
+import { xcodeProjectAddNse } from "./onesignal/withOneSignalIos";
+
+// Quick testing on any Xcode project
+
+// 1. Update values for your project
+// 2. Run `yarn build` from here
+// 3. Open a terminal to the root of your Xcode project
+// 4. Run `node ~/WHERE_YOU_CLONED_ME/onesignal-expo-plugin/build/testRuniOS.js`
+// 5. Run `pod init`, if you haven't already.
+//    - Make sure you are testing with 2 targets in your Podfile, your main target AND your NSE
+//    - If you forget your main target in your Podfile you will get the
+//     "Please add the host targets for the embedded targets to the Podfile." error
+//      even if your .xcodeproj is correct.
+xcodeProjectAddNse(
+    "XcodeTestProj", 
+    ".", 
+    "com.onesignal.XcodeTestProj",
+    "99SW8E36CT",
+    "../../repos/onesignal-expo-plugin/support/serviceExtensionFiles/"
+); 

package/tsconfig.json

@@ -10,6 +10,7 @@
     ],
     "exclude": [
         "**/__mocks__/*",
-        "**/__tests__/*"
+        "**/__tests__/*",
+        "examples"
     ]
 }

package/types/xcode.d.ts

@@ -0,0 +1,8 @@
+declare module 'xcode' {
+  interface xcode {
+    project(projPath: string): any;
+  }
+
+  const xcode: xcode;
+  export default xcode;
+}