onesignal-expo-plugin 1.0.0-beta9 → 1.0.2

package/.eslintignore

@@ -0,0 +1,6 @@
+# don't ever lint node_modules
+node_modules
+# don't lint build output (make sure it's set to your correct build folder name)
+build
+# don't lint the examples projects
+examples

package/.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  parserOptions: {
+    project: "tsconfig.json",
+},
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  rules: {
+    "@typescript-eslint/no-floating-promises": "error",
+    "no-extra-boolean-cast": "off"
+  }
+};

package/.github/ISSUE_TEMPLATE/ask-question.yml

@@ -0,0 +1,50 @@
+name: 🙋‍♂️ Ask a question
+description: Tell us what's on your mind
+title: "[question]: "
+labels: ["triage"]
+# assignees:
+#   - assign your sdk team e.g., onesignal/unity
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Having issues integrating this SDK?
+  - type: textarea
+    id: question
+    attributes:
+      label: How can we help?
+      description: Specific question regarding integrating this SDK.
+      placeholder: How do I...?
+    validations:
+      required: true
+  - type: textarea
+    id: expo-sdk-version
+    attributes:
+      label: OneSignal Expo SDK version
+      description: The version of the OneSignal Expo SDK you have a question for.
+      placeholder: 1.0.0
+    validations:
+      required: true
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: Which platform are you having an issue with?
+      multiple: true
+      options:
+        - iOS
+        - Android
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: Shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](#insert-project-code-of-conduct-here)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,71 @@
+name: 🪳 Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+# assignees:
+#   - assign your sdk team e.g., onesignal/unity
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Provide a thorough description of whats going on.
+      placeholder: The latest version of the SDK causes my screen to go blank when I tap on the screen three times.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce?
+      description: Provide as much detail as posible to reproduce the issue.
+      placeholder: |
+        1. Install vX.Y.Z of dependency
+        2. Launch the app on iOS device
+        3. Tap the screen three times
+        4. Note that the app crashes
+      render: Markdown
+    validations:
+      required: true
+  - type: textarea
+    id: what-are-expectations
+    attributes:
+      label: What did you expect to happen?
+      description: Also tell us, what did you expect to happen?
+      placeholder: I expected the app to continue running no matter how many times I tap the screen.
+    validations:
+      required: true
+  - type: textarea
+    id: expo-sdk-version
+    attributes:
+      label: OneSignal Expo SDK version
+      description: The version of the OneSignal Expo SDK used in your app.
+      placeholder: 1.0.0
+    validations:
+      required: true
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: Which platform are you having an issue with?
+      multiple: true
+      options:
+        - iOS
+        - Android
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: Shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](#insert-project-code-of-conduct-here)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

package/.github/ISSUE_TEMPLATE/general-feedback.yml

@@ -0,0 +1,27 @@
+name: 📣 General feedback
+description: Tell us what's on your mind
+title: "[feedback]: "
+labels: ["triage"]
+# assignees:
+#   - assign your sdk team e.g., onesignal/unity
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for sharing your valuable feedback!
+  - type: textarea
+    id: feedback
+    attributes:
+      label: What's on your mind?
+      description: Feedback regarding this SDK.
+      placeholder: Share your feedback...
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](#insert-project-code-of-conduct-here)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

package/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## April 2022
+### `1.0.1` - 04/11/22
+
+#### Changes
+- Add more info regarding the `expo prebuild` command to README.
+#### Fixes
+- Upstream EAS workaround for "Missing Push Capability on iOS" issue. Adds `aps-environment` entitlement to NSE template. Although it is **not** required in normal builds, there is an upstream limitation from EAS that is resolved by including the push entitlement in both target entitlement files. As of 4/8/22, EAS builds will randomly pick an entitlement file if there are multiple in a project without differentiating among targets. This is resulting in flaky builds where half the time they work and half the time they don't. This can be seen as a temporary fix. Note it carries no side-effects / repercussions (i.e: the entitlement is superfluous but not critical to remove in the future).
+
+## March 2022
+### `1.0.0` - 03/28/22
+
+#### Fixes
+- Upgrade dependencies (via dependabot)
+#### Changes
+- Add credentials guide and update README
+- Advance to General Availability
+
+## February 2022
+### `1.0.0-beta11` - 02/18/2022
+#### Added
+- Linting
+- Instead of creating a "WriterManager", we repurpose the ReaderManager class by renaming it to FileManager and adding a synchronized write helper function (synchronous in the sense that it block further execution until complete).
+- iOS constants file
+
+#### Fixes
+- Import cleanups
+- Linting errors
+- Write safety issu. NSE updater helper functions were previously writing to the entitlements & plist files asynchronously. We should await on each to ensure we don't have multiple writes to the same file at once (which is unsafe).
+
+## January 2022
+
+### `1.0.0-beta10` - 01/24/2022
+#### Added
+- ability to configure version numbers used in the NSE target's plist file.
+- `OneSignalLog` class for better console logging.
+- this changelog file.
+
+#### Fixed
+- re-running `expo prebuild` will no longer result in duplicate entitlements and dependencies added to native files.

package/EAS.md

@@ -0,0 +1,21 @@
+# Expo Application Services
+EAS is Expo's cloud-build service.
+
+## [EAS Homepage](https://expo.dev/eas)
+
+## EAS + OneSignal Setup
+To get OneSignal push notifications working in an EAS-built app, see our guide on how to configure your [iOS credentials](IOS_CREDENTIALS_EAS.md).
+
+## How to run an iOS EAS-built app
+### Run in a production environment
+For production builds, your generated ipa file should to be distributed to the App Store or Testflight.
+
+
+### Run in custom development client
+For development/internal distribution builds, you will need to install a [development client](https://docs.expo.dev/development/getting-started/) on your iOS device.
+
+1. Scan the QR code shown in the terminal after EAS build success and install the development client application to your device.
+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!

package/IOS_CREDENTIALS_EAS.md

@@ -0,0 +1,170 @@
+# iOS Credentials Guide: OneSignal + EAS
+## Overview
+To distribute your iOS application, you must set up all the credentials required by Apple. The 3 primary iOS credentials are:
+* Distribution certificate
+* Provisioning profiles
+* Push notification certificate
+
+If you are using EAS, you may be letting Expo handle all your credentials. This is fine for your distribution and provisioning credentials. However, the push notification certificate *must* be set up separately since you are using OneSignal.
+
+### Push Notification Certificate
+To set up OneSignal on iOS, you will need a [push notification certificate](https://documentation.onesignal.com/docs/generate-an-ios-push-certificate). The push certificate is used to send notifications to devices and has nothing to do with the build process. After you have uploaded the certificate to OneSignal, it should just work.
+
+### Capabilities
+As of eas-cli `v0.52.0`, the previous capabilities issues should now be resolved. See the [release notes](https://github.com/expo/eas-cli/releases/tag/v0.52.0) for details.
+
+You can still view the old instructions by clicking below.
+
+<details>
+  <summary>Click to expand</summary>
+
+---
+To receive notifications, you must add the `aps-environment` capability (Push Notifications) to your app at build time. The OneSignal plugin tries to facilitate this as much as possible but there could be complications if you added other capabilities/entitlements or another config plugin did. This is because EAS doesn't currently respect entitlement files on a per-target basis. If there are more than one entitlements files, it simply picks one and applies it to both targets.
+
+Due to this, there are two setup paths:
+1. A **simple setup** is one in which the only [capability](https://docs.expo.dev/build-reference/ios-capabilities/) on your main target is "Push Notifications."
+2. A more **complex setup** is one in which you have other capabilities.
+
+This also affects how you should set up your credentials. Use the following table to know whether to proceed with local or managed credentials:
+| Push Notification capability only |                                                                       |
+|-----------------------------------|-----------------------------------------------------------------------|
+| Local credentials                 | Works but unnecessary to go through extra effort to use local signing |
+| Managed credentials               | Works (simple setup)                                                                 |
+
+| Multiple capabilities |                                  |
+|-----------------------|----------------------------------|
+| Local credentials     | Works but requires complex setup |
+| Managed credentials   | Works unreliably                 |
+
+If you are unsure, run `expo prebuild` and look at the native entitlements file of your main target (in `ios` directory). Other config plugins may be adding capabilities here. Or check the full [capabilities](https://docs.expo.dev/build-reference/ios-capabilities/#supported-capabilities) list supported by Expo.
+
+
+#### Simple setup explanation
+Since there is only one capability (Push Notifications) required by your app, everything should just work. OneSignal will automatically add the capability to your app along with the necessary App Groups and EAS should sync them with your Apple Developer account. You can choose to use managed signing on EAS without a problem. This works because OneSignal will add the capability to both targets' entitlements files.
+
+#### Complex setup explanation
+Having additional capabilities on your app will result in a more complex setup, including having to use local credentials. The following is an explanation of why. It is not imperative to understand but we have included it for context.
+
+The OneSignal plugin will create an additional target: `OneSignalNotificationServiceExtension`. This target is the iOS service extension that adds support for Confirmed Deliveries, badges, media attachments, action buttons, and influenced opens (Firebase Analytics). Learn more [here](https://documentation.onesignal.com/docs/service-extensions). The plugin will automatically add app groups to both targets' entitlements files which are required if you want to make use of these features. They allow your app to execute code when a notification is received, even if your app is not active.
+
+Each target has an entitlement file. If there are multiple entitlements files per project, EAS will randomly pick one and apply it to both targets. To mitigate this, we have added the push capability entilement to both files (even though it's really only necessary in the main target). This can still pose a problem if it picks the NSE's entitlements file since it *could* break any other capabilities in your project, given that file will not have capabilities added to your main target by yourself or other plugins.
+
+The following section details how to mitigate these issues and not break your other capabilities.
+
+## Complex Setup
+
+### 1. Credentials setup
+To build successfully, you will need to create and use local credentials (one for production and development). Add `"credentialsSource": "local"` to your `eas.json` file.
+
+**Example:**
+```json
+{
+  "build": {
+    "release": {
+      "android": {
+        "gradleCommand": ":app:bundleRelease"
+      },
+      "ios": {
+        "credentialsSource": "local",
+        "buildConfiguration": "Release"
+      }
+    },
+    "development": {
+      "developmentClient": true,
+      "distribution": "internal",
+      "credentialsSource": "local"
+    }
+  }
+}
+```
+
+### 2. Identifiers
+In your [Apple developer console](https://developer.apple.com) create two identifiers with the following format:
+   - `<com.example.app>` <-- you likely already have this one
+   - `<com.example.app>.OneSignalNotificationServiceExtension`
+
+#### When modifying your existing main app identifier:
+   - add the App Groups capability like so: `group.<identifier>.onesignal`
+   - keep / add the "Push Notifications" capability
+
+#### When creating a new identifier for `OneSignalNotificationServiceExtension`:
+   - select AppId from the list of identifier types
+   - select App when choosing between App and App Clip
+   - add the App Groups capability like so: `group.<identifier>.onesignal`
+   - do not add the "Push Notifications" capability
+
+#### Note on App Groups at Build Time:
+Make sure to build with both identifiers containing the AppGroup simultaneously. To troubleshoot, remove them both and then rebuild with both identifiers' AppGroup capabilities enabled.
+
+### 3. Provisioning
+Create AdHoc (local development) and AppStore (production) provisioning profiles with both identifiers (four provisioning profiles total). Both provisioning profiles should use the same distribution certificate that is used by your app. Download the profiles.
+
+### 4. Add the profiles to your `credentials.json` file:
+Use the same distribution certificate for the `OneSignalNotificationServiceExtension` as is used for your app (no need to create a new cert).
+
+We recommend creating a `certs` directory in your project with subdirectories for each build type (e.g: `certs/adhoc` & `certs/appstore`). Doing so, you can more easily switch which provisioning profiles get used at build time.
+
+**Directory structure:**
+```
+/certs
+   - /adhoc
+   - /appstore
+```
+
+**Example `credentials.json`:**
+```json
+{
+    "ios": {
+        "<PROJECT>": {
+            "distributionCertificate": {
+                "path": "certs/ios_distribution_certificate.p12",
+                "password": "***"
+            },
+            "provisioningProfilePath": "certs/adhoc/***mobileappprofile.mobileprovision"
+        },
+        "OneSignalNotificationServiceExtension": {
+            "distributionCertificate": {
+                "path": "certs/ios_distribution_certificate.p12",
+                "password": "***"
+            },
+            "provisioningProfilePath": "certs/adhoc/***onesignalprofile.mobileprovision"
+        }
+    }
+}
+```
+
+**Note:** your push certificate (p12) file should not appear anywhere in the `credentials.json` file.
+
+## Build (complex setup continued)
+
+**IMPORTANT**: run the `eas build` command with `EXPO_NO_CAPABILITY_SYNC` if you want to prevent EAS from syncing capabilities (e.g: overwriting the steps you took in the complex setup).
+
+### Release
+If you are ready for a production build, you should use the AppStore provisioning profiles you created. Make sure your `credentials.json` file is using the correct profiles.
+
+### Development
+The development build will use the AdHoc provisioning profiles you created. Make sure your `credentials.json` file is using the correct profiles.
+
+---
+</details>
+
+### Expo development client
+If you haven't already, add the expo development client to your project:
+
+```sh
+expo install expo-dev-client
+```
+
+Make sure `"developmentClient": true,` is set in your `eas.json` development build profile.
+
+### Run the EAS build command
+```sh
+eas build --profile <build profile> --platform ios
+```
+where `<build profile>` refers to the build profile in your `eas.json` file (e.g: "development" vs "release").
+
+### Build success
+At this point, your build should succeed. You can check its progress by opening the build link in the terminal.
+
+## How to run on your device
+See our [EAS guide](EAS.md) for instructions.

package/README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Welcome to onesignal-expo-plugin 👋</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0--beta9-blue.svg?cacheSeconds=2592000" />
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0.1-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>
@@ -17,7 +17,6 @@
 * 🏠 [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.
 
@@ -32,6 +31,11 @@ This plugin is an [Expo Config Plugin](https://docs.expo.dev/guides/config-plugi
 
 ```sh
 expo install onesignal-expo-plugin
+
+# npm
+npm install react-native-onesignal
+
+# yarn
 yarn add react-native-onesignal
 ```
 
@@ -105,15 +109,50 @@ Alternatively, pass the app ID directly to the function:
 OneSignal.setAppId("YOUR-ONESIGNAL-APP-ID");
 ```
 
-## Run
+### Versioning
+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. |
+
+\* 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
-$ expo prebuild --clean
+expo prebuild
+```
 
-# Build your native iOS project
-$ expo run:ios
+```sh
+# nukes changes and rebuilds
+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.
+
+## 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
 
-# Build your native Android project
-$ expo run:android
+# Build and run your native Android project
+expo run:android
 ```
 
 ---

package/build/onesignal/withOneSignalAndroid.js

@@ -6,26 +6,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withOneSignalAndroid = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
-// ---------- ---------- ---------- ----------
-const oneSignalGradle = `
-buildscript {
-    repositories {
-        gradlePluginPortal()
-    }
-    dependencies {
-        classpath 'gradle.plugin.com.onesignal:onesignal-gradle-plugin:[0.12.10, 0.99.99]'
-    }
-}
-
-apply plugin: 'com.onesignal.androidsdk.onesignal-gradle-plugin'`;
-// ---------- ---------- ---------- ----------
+const androidConstants_1 = require("../support/androidConstants");
+const OneSignalLog_1 = require("../support/OneSignalLog");
 const withGradleBuildConfig = (config) => {
     return (0, config_plugins_1.withAppBuildGradle)(config, (newConfig) => {
-        newConfig.modResults.contents = `${oneSignalGradle.trimStart()}\n\n${newConfig.modResults.contents}`;
+        let { contents } = newConfig.modResults;
+        // make sure we haven't previously added dependencies
+        if (!contents.includes(androidConstants_1.ONESIGNAL_GRADLE)) {
+            contents = `${androidConstants_1.ONESIGNAL_GRADLE}\n${contents}`;
+        }
+        else {
+            OneSignalLog_1.OneSignalLog.log("OneSignal dependencies already added to build.gradle. Skipping...");
+        }
+        newConfig.modResults.contents = contents;
         return newConfig;
     });
 };
-// ---------- ---------- ---------- ----------
 const withOneSignalAndroid = (config, props) => {
     withGradleBuildConfig(config, props);
     return config;