onesignal-expo-plugin 1.2.0 → 1.3.1

package/.github/release-drafter.yml

@@ -0,0 +1,27 @@
+name-template: $RESOLVED_VERSION
+tag-template: $RESOLVED_VERSION
+categories:
+  - title: 🚀 Features
+    label: Enhancement / Feature
+  - title: 🐛 Bug Fixes
+    label: Bug
+  - title: 🧰 Improvements
+    label: Improvement  
+  - title: down arrow Dependency Updates
+    label: Dependencies 
+change-template: '- $TITLE (#$NUMBER)'
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Other Changes
+  
+  $CHANGES

package/.github/workflows/Zapier.yml

@@ -0,0 +1,29 @@
+# This is an action to close asana tasks that were generated by Github issues
+
+name: Zapier web hook
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  issues:
+    types: [closed]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Runs a set of commands using the runners shell
+      - name: Call Zapier web hook to close Asana task
+        if: ${{ !github.event.issue.pull_request }}
+        run: |
+          curl --location --request POST 'https://hooks.zapier.com/hooks/catch/12728683/b7009qc/' \
+          --header 'Content-Type: application/json' \
+          --header 'Accept: application/json' \
+          --data-raw '{
+            "task_name" : "${{ github.event.issue.title }}"
+          }'

package/.github/workflows/release-drafter.yml

@@ -0,0 +1,42 @@
+
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      # (Optional) GitHub Enterprise requires GHE_HOST variable set
+      #- name: Set GHE_HOST
+      #  run: |
+      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
+
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+        # with:
+        #   config-name: my-config.yml
+        #   disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## March 2023
+### `1.3.1` - 03/03/23
+#### Changes
+- Update monorepo logic to rely on the more reliable `require.resolve` to find the `onesignal-expo-plugin` package.
+
+## November 2022
+### `1.3.0` - 11/30/22
+#### Changes
+- Add `iosNSEFilePath` configuration options to the plugin, which allows an app to specify a custom iOS Notification Service Extension.
+
 ## October 2022
 ### `1.2.0` - 10/25/22
 #### Changes

package/EAS.md

@@ -18,4 +18,4 @@ For development/internal distribution builds, you will need to install a [develo
 2. In the terminal, run `expo start --dev-client` to be able to serve the application to the client.
 3. Scan the generated QR code to open the dev client and fetch the app bundle from the running Expo process.
 4. You may be prompted to allow the app to find local area network devices. Approve.
-5. Rescan the QR code & open the app. At this point, you should see the mero bundler working. As soon as the bundle is complete, your working app should open!
+5. Rescan the QR code & open the app. At this point, you should see the metro bundler working. As soon as the bundle is complete, your working app should open!

package/README.md

@@ -1,4 +1,4 @@
-<h1 align="center">Welcome to onesignal-expo-plugin 👋</h1>
+<h1 align="center">Welcome to the onesignal-expo-plugin 👋</h1>
 <p>
   <a href="https://www.npmjs.com/package/onesignal-expo-plugin" target="_blank">
     <img alt="Version" src="https://img.shields.io/npm/v/onesignal-expo-plugin.svg">
@@ -30,9 +30,10 @@ This plugin is an [Expo Config Plugin](https://docs.expo.dev/guides/config-plugi
 ---
 
 ## Install
+You need both the `onesignal-expo-plugin` *and* the `react-native-onesignal` npm package.
 
 ```sh
-expo install onesignal-expo-plugin
+npx expo install onesignal-expo-plugin
 
 # npm
 npm install react-native-onesignal
@@ -43,7 +44,7 @@ yarn add react-native-onesignal
 
 ## 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 `expo install`. Just make sure it is the first plugin in the array and to configure any desired plugin props:
+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
@@ -86,6 +87,7 @@ You can pass props to the plugin config object to configure:
 | `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.                                                                                                |
+| `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"`. |
 
 ### OneSignal App ID
 Add your OneSignal App ID to your [Expo constants via the `extra` param](https://docs.expo.dev/versions/latest/config/app/):
@@ -117,9 +119,10 @@ OneSignal.setAppId("YOUR-ONESIGNAL-APP-ID");
 In your configuration file, make sure you set:
 
 | Property             | Details                                                                                                                                                                      |
-|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `version`         | Your app version. Corresponds to `CFBundleShortVersionString` on iOS. 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. This value will be used in your NSE* target's plist file. |
+|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `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).
 
@@ -139,24 +142,24 @@ It may make sense to prebuild locally to inspect config plugin changes and help
 
 #### Run
 ```sh
-expo prebuild
+npx expo prebuild
 ```
 
 ```sh
 # nukes changes and rebuilds
-expo prebuild --clean
+npx expo prebuild --clean
 ```
 
-**EAS Note:** if you choose to stay in a fully managed workflow by not prebuilding, EAS will still run `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.
+**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.
 ```sh
 # Build and run your native iOS project
-expo run:ios
+npx expo run:ios
 
 # Build and run your native Android project
-expo run:android
+npx expo run:android
 ```
 
 ---
@@ -178,5 +181,5 @@ Give a ⭐️ if this project helped you!
 
 ## 📝 License
 
-Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
+Copyright © 2023 [OneSignal](https://github.com/OneSignal).<br />
 This project is [MIT](https://github.com/OneSignal/onesignal-expo-plugin/blob/main/LICENSE) licensed.

package/build/onesignal/withOneSignalIos.js

@@ -33,6 +33,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.xcodeProjectAddNse = exports.withOneSignalIos = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
 const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
 const xcode_1 = __importDefault(require("xcode"));
 const iosConstants_1 = require("../support/iosConstants");
 const updatePodfile_1 = require("../support/updatePodfile");
@@ -105,15 +106,12 @@ const withOneSignalNSE = (config, onesignalProps) => {
             bundleVersion: (_b = props.ios) === null || _b === void 0 ? void 0 : _b.buildNumber,
             bundleShortVersion: props === null || props === void 0 ? void 0 : props.version,
             mode: onesignalProps === null || onesignalProps === void 0 ? void 0 : onesignalProps.mode,
-            iPhoneDeploymentTarget: onesignalProps === null || onesignalProps === void 0 ? void 0 : onesignalProps.iPhoneDeploymentTarget
+            iPhoneDeploymentTarget: onesignalProps === null || onesignalProps === void 0 ? void 0 : onesignalProps.iPhoneDeploymentTarget,
+            iosNSEFilePath: onesignalProps.iosNSEFilePath
         };
-        // support for monorepos where node_modules can be up to 5 parents
-        // above the project directory.
-        let dir = "node_modules";
-        for (let x = 0; x < 5 && !FileManager_1.FileManager.dirExists(dir); x++) {
-            dir = "../" + dir;
-        }
-        xcodeProjectAddNse(props.modRequest.projectName || "", options, dir + "/onesignal-expo-plugin/build/support/serviceExtensionFiles/");
+        // support for monorepos where node_modules can be above the project directory.
+        const pluginDir = require.resolve("onesignal-expo-plugin/package.json");
+        xcodeProjectAddNse(props.modRequest.projectName || "", options, path.join(pluginDir, "../build/support/serviceExtensionFiles/"));
         return props;
     });
 };
@@ -133,13 +131,13 @@ const withOneSignalIos = (config, props) => {
 };
 exports.withOneSignalIos = withOneSignalIos;
 function xcodeProjectAddNse(appName, options, sourceDir) {
-    const { iosPath, devTeam, bundleIdentifier, bundleVersion, bundleShortVersion, iPhoneDeploymentTarget } = options;
+    const { iosPath, devTeam, bundleIdentifier, bundleVersion, bundleShortVersion, iPhoneDeploymentTarget, iosNSEFilePath } = options;
     // not awaiting in order to not block main thread
     (0, updatePodfile_1.updatePodfile)(iosPath).catch(err => { OneSignalLog_1.OneSignalLog.error(err); });
     const projPath = `${iosPath}/${appName}.xcodeproj/project.pbxproj`;
+    const sourceFile = "NotificationService.m";
     const extFiles = [
         "NotificationService.h",
-        "NotificationService.m",
         `${iosConstants_1.NSE_TARGET_NAME}.entitlements`,
         `${iosConstants_1.NSE_TARGET_NAME}-Info.plist`
     ];
@@ -156,13 +154,17 @@ function xcodeProjectAddNse(appName, options, sourceDir) {
             const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${extFile}`;
             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 = iosNSEFilePath !== null && iosNSEFilePath !== void 0 ? iosNSEFilePath : `${sourceDir}${sourceFile}`;
+        const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${sourceFile}`;
+        await FileManager_1.FileManager.copyFile(`${sourcePath}`, targetFile);
         /* MODIFY COPIED EXTENSION FILES */
         const nseUpdater = new NseUpdaterManager_1.default(iosPath);
         await nseUpdater.updateNSEEntitlements(`group.${bundleIdentifier}.onesignal`);
         await nseUpdater.updateNSEBundleVersion(bundleVersion !== null && bundleVersion !== void 0 ? bundleVersion : iosConstants_1.DEFAULT_BUNDLE_VERSION);
         await nseUpdater.updateNSEBundleShortVersion(bundleShortVersion !== null && bundleShortVersion !== void 0 ? bundleShortVersion : iosConstants_1.DEFAULT_BUNDLE_SHORT_VERSION);
         // Create new PBXGroup for the extension
-        const extGroup = xcodeProject.addPbxGroup(extFiles, iosConstants_1.NSE_TARGET_NAME, iosConstants_1.NSE_TARGET_NAME);
+        const extGroup = xcodeProject.addPbxGroup([...extFiles, sourceFile], 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"];

package/onesignal/withOneSignalIos.ts

@@ -10,6 +10,7 @@ import {
   withXcodeProject,
 } from "@expo/config-plugins";
 import * as fs from 'fs';
+import * as path from 'path';
 import xcode from 'xcode';
 import {
   DEFAULT_BUNDLE_SHORT_VERSION,
@@ -102,20 +103,17 @@ const withOneSignalNSE: ConfigPlugin<OneSignalPluginProps> = (config, onesignalP
       bundleVersion: props.ios?.buildNumber,
       bundleShortVersion: props?.version,
       mode: onesignalProps?.mode,
-      iPhoneDeploymentTarget: onesignalProps?.iPhoneDeploymentTarget
+      iPhoneDeploymentTarget: onesignalProps?.iPhoneDeploymentTarget,
+      iosNSEFilePath: onesignalProps.iosNSEFilePath
     };
 
-    // support for monorepos where node_modules can be up to 5 parents
-    // above the project directory.
-    let dir = "node_modules"
-    for(let x=0; x < 5 && !FileManager.dirExists(dir); x++) {
-      dir = "../" + dir
-    }
+    // support for monorepos where node_modules can be above the project directory.
+    const pluginDir = require.resolve("onesignal-expo-plugin/package.json")
 
     xcodeProjectAddNse(
       props.modRequest.projectName || "",
       options,
-      dir + "/onesignal-expo-plugin/build/support/serviceExtensionFiles/"
+      path.join(pluginDir, "../build/support/serviceExtensionFiles/")
     );
 
     return props;
@@ -145,16 +143,16 @@ export function xcodeProjectAddNse(
   options: PluginOptions,
   sourceDir: string
 ): void {
-  const { iosPath, devTeam, bundleIdentifier, bundleVersion, bundleShortVersion, iPhoneDeploymentTarget } = options;
+  const { iosPath, devTeam, bundleIdentifier, bundleVersion, bundleShortVersion, iPhoneDeploymentTarget, iosNSEFilePath } = options;
 
   // not awaiting in order to not block main thread
   updatePodfile(iosPath).catch(err => { OneSignalLog.error(err) });
 
   const projPath = `${iosPath}/${appName}.xcodeproj/project.pbxproj`;
 
+  const sourceFile = "NotificationService.m"
   const extFiles = [
     "NotificationService.h",
-    "NotificationService.m",
     `${NSE_TARGET_NAME}.entitlements`,
     `${NSE_TARGET_NAME}-Info.plist`
   ];
@@ -176,6 +174,11 @@ export function xcodeProjectAddNse(
       await FileManager.copyFile(`${sourceDir}${extFile}`, targetFile);
     }
 
+    // Copy NSE source file either from configuration-provided location, falling back to the default one.
+    const sourcePath = iosNSEFilePath ?? `${sourceDir}${sourceFile}`
+    const targetFile = `${iosPath}/${NSE_TARGET_NAME}/${sourceFile}`;
+    await FileManager.copyFile(`${sourcePath}`, targetFile);
+
     /* MODIFY COPIED EXTENSION FILES */
     const nseUpdater = new NseUpdaterManager(iosPath);
     await nseUpdater.updateNSEEntitlements(`group.${bundleIdentifier}.onesignal`)
@@ -183,7 +186,7 @@ export function xcodeProjectAddNse(
     await nseUpdater.updateNSEBundleShortVersion(bundleShortVersion ?? DEFAULT_BUNDLE_SHORT_VERSION);
 
     // Create new PBXGroup for the extension
-    const extGroup = xcodeProject.addPbxGroup(extFiles, NSE_TARGET_NAME, NSE_TARGET_NAME);
+    const extGroup = xcodeProject.addPbxGroup([...extFiles, sourceFile], NSE_TARGET_NAME, NSE_TARGET_NAME);
 
     // Add the new PBXGroup to the top level group. This makes the
     // files / folder appear in the file explorer in Xcode.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "The OneSignal Expo plugin allows you to use OneSignal without leaving the managed workflow. Developed in collaboration with SweetGreen.",
   "main": "./app.plugin.js",
   "scripts": {

package/types/types.ts

@@ -28,6 +28,13 @@
    * (optional) The large notification icons for Android. Images will be automatically scaled up/down to 256x256.
    */
   largeIcons?:            string[];
+
+  /**
+   * (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 found at (support/serviceExtensionFiles/NotificationService.m, then altered to support any custom
+   * logic required.
+   */
+   iosNSEFilePath?:       string;
 };
 
 /**
@@ -41,7 +48,8 @@ export type PluginOptions = {
   bundleVersion?:           string,
   bundleShortVersion?:      string,
   bundleIdentifier?:        string,
-  iPhoneDeploymentTarget?:  string
+  iPhoneDeploymentTarget?:  string,
+  iosNSEFilePath?:          string
 }
 
 export enum Mode {