onesignal-expo-plugin 2.0.0 → 2.0.1

package/README.md

@@ -87,10 +87,11 @@ 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.                                                                                                |
+| `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"`. |
 
 ### OneSignal App ID
-Add your OneSignal App ID to your [Expo constants via the `extra` param](https://docs.expo.dev/versions/latest/config/app/):
+Add your OneSignal App ID to your [Expo constants via the `extra` param](https://docs.expo.dev/versions/latest/config/app/#extra):
 
 **Example:**
 ```json
@@ -101,18 +102,18 @@ 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:
+You can then access the value to pass to the `initialize` function:
 
 ```js
 import OneSignal from 'react-native-onesignal';
 import Constants from "expo-constants";
-OneSignal.setAppId(Constants.manifest.extra.oneSignalAppId);
+OneSignal.initialize(Constants.expoConfig.extra.oneSignalAppId);
 ```
 
 Alternatively, pass the app ID directly to the function:
 
 ```js
-OneSignal.setAppId("YOUR-ONESIGNAL-APP-ID");
+OneSignal.initialize("YOUR-ONESIGNAL-APP-ID");
 ```
 
 ### Versioning

package/build/onesignal/withOneSignal.js

@@ -6,7 +6,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const withOneSignalAndroid_1 = require("./withOneSignalAndroid");
 const withOneSignalIos_1 = require("./withOneSignalIos");
+const helpers_1 = require("../support/helpers");
 const withOneSignal = (config, props) => {
+    // if props are undefined, throw error
+    if (!props) {
+        throw new Error('You are trying to use the OneSignal plugin without any props. Property "mode" is required. Please see https://github.com/OneSignal/onesignal-expo-plugin for more info.');
+    }
+    (0, helpers_1.validatePluginProps)(props);
     config = (0, withOneSignalIos_1.withOneSignalIos)(config, props);
     config = (0, withOneSignalAndroid_1.withOneSignalAndroid)(config, props);
     return config;

package/build/onesignal/withOneSignalAndroid.js

@@ -58,6 +58,30 @@ const withLargeIcons = (config, onesignalProps) => {
         },
     ]);
 };
+const withSmallIconAccentColor = (config, onesignalProps) => {
+    if (!onesignalProps.smallIconAccentColor) {
+        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 : [];
+        // 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;
+        });
+        if (!hasAccentColor) {
+            const accentColorEntry = {
+                $: { name: 'onesignal_notification_accent_color' },
+                _: colorInARGB,
+            };
+            config.modResults.resources.string = [...strings, accentColorEntry];
+        }
+        return config;
+    });
+};
 async function saveIconsArrayAsync(projectRoot, icons, dirsToSize) {
     for (const icon of icons) {
         await saveIconAsync(icon, projectRoot, dirsToSize);
@@ -84,6 +108,7 @@ async function saveIconAsync(icon, projectRoot, dirsToSize) {
 const withOneSignalAndroid = (config, props) => {
     config = withSmallIcons(config, props);
     config = withLargeIcons(config, props);
+    config = withSmallIconAccentColor(config, props);
     return config;
 };
 exports.withOneSignalAndroid = withOneSignalAndroid;

package/build/support/helpers.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePluginProps = void 0;
+const types_1 = require("../types/types");
+function validatePluginProps(props) {
+    // check the type of each property
+    if (typeof props.mode !== "string") {
+        throw new Error("OneSignal Expo Plugin: 'mode' must be a string.");
+    }
+    if (props.devTeam && typeof props.devTeam !== "string") {
+        throw new Error("OneSignal Expo Plugin: 'devTeam' must be a string.");
+    }
+    if (props.iPhoneDeploymentTarget && typeof props.iPhoneDeploymentTarget !== "string") {
+        throw new Error("OneSignal Expo Plugin: 'iPhoneDeploymentTarget' must be a string.");
+    }
+    if (props.smallIcons && !Array.isArray(props.smallIcons)) {
+        throw new Error("OneSignal Expo Plugin: 'smallIcons' must be an array.");
+    }
+    if (props.smallIconAccentColor && typeof props.smallIconAccentColor !== "string") {
+        throw new Error("OneSignal Expo Plugin: 'smallIconAccentColor' must be a string.");
+    }
+    if (props.largeIcons && !Array.isArray(props.largeIcons)) {
+        throw new Error("OneSignal Expo Plugin: 'largeIcons' must be an array.");
+    }
+    if (props.iosNSEFilePath && typeof props.iosNSEFilePath !== "string") {
+        throw new Error("OneSignal Expo Plugin: 'iosNSEFilePath' must be a string.");
+    }
+    // check for extra properties
+    const inputProps = Object.keys(props);
+    for (const prop of inputProps) {
+        if (!types_1.ONESIGNAL_PLUGIN_PROPS.includes(prop)) {
+            throw new Error(`OneSignal Expo Plugin: You have provided an invalid property "${prop}" to the OneSignal plugin.`);
+        }
+    }
+}
+exports.validatePluginProps = validatePluginProps;

package/build/types/types.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mode = void 0;
+exports.Mode = exports.ONESIGNAL_PLUGIN_PROPS = void 0;
+exports.ONESIGNAL_PLUGIN_PROPS = [
+    "mode",
+    "devTeam",
+    "iPhoneDeploymentTarget",
+    "smallIcons",
+    "largeIcons",
+    "iosNSEFilePath",
+    "smallIconAccentColor"
+];
 var Mode;
 (function (Mode) {
     Mode["Dev"] = "development";

package/onesignal/withOneSignal.ts

@@ -7,8 +7,18 @@ import { ConfigPlugin } from '@expo/config-plugins';
 import { OneSignalPluginProps } from '../types/types';
 import { withOneSignalAndroid } from './withOneSignalAndroid';
 import { withOneSignalIos } from './withOneSignalIos';
+import { validatePluginProps } from '../support/helpers';
 
 const withOneSignal: ConfigPlugin<OneSignalPluginProps> = (config, props) => {
+  // if props are undefined, throw error
+  if (!props) {
+    throw new Error(
+      'You are trying to use the OneSignal plugin without any props. Property "mode" is required. Please see https://github.com/OneSignal/onesignal-expo-plugin for more info.'
+    );
+  }
+
+  validatePluginProps(props);
+
   config = withOneSignalIos(config, props);
   config = withOneSignalAndroid(config, props);
 

package/onesignal/withOneSignalAndroid.ts

@@ -3,7 +3,7 @@
  * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
  */
 
-import { ConfigPlugin, withDangerousMod } from '@expo/config-plugins';
+import { ConfigPlugin, withDangerousMod, withStringsXml } from '@expo/config-plugins';
 import { generateImageAsync } from '@expo/image-utils';
 import { OneSignalLog } from '../support/OneSignalLog';
 import { OneSignalPluginProps } from '../types/types';
@@ -72,6 +72,35 @@ const withLargeIcons: ConfigPlugin<OneSignalPluginProps> = (
   ]);
 };
 
+const withSmallIconAccentColor: ConfigPlugin<OneSignalPluginProps> = (config, onesignalProps) => {
+  if(!onesignalProps.smallIconAccentColor) {
+    return config
+  }
+
+  return withStringsXml(config, (config) => {
+    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) =>
+        stringEntry.$?.name === 'onesignal_notification_accent_color' &&
+        stringEntry._ === colorInARGB
+    );
+
+    if (!hasAccentColor) {
+      const accentColorEntry = {
+        $: { name: 'onesignal_notification_accent_color' },
+        _: colorInARGB,
+      };
+
+      config.modResults.resources.string = [...strings, accentColorEntry];
+    }
+
+    return config;
+  });
+}
+
 async function saveIconsArrayAsync(projectRoot: string, icons: string[], dirsToSize: { [name: string]: number }) {
   for(const icon of icons) {
     await saveIconAsync(icon, projectRoot, dirsToSize);
@@ -113,5 +142,6 @@ export const withOneSignalAndroid: ConfigPlugin<OneSignalPluginProps> = (
 ) => {
   config = withSmallIcons(config, props);
   config = withLargeIcons(config, props);
+  config = withSmallIconAccentColor(config, props);
   return config;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "2.0.0",
+  "version": "2.0.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/support/helpers.ts

@@ -0,0 +1,41 @@
+import { ONESIGNAL_PLUGIN_PROPS } from "../types/types";
+
+export function validatePluginProps(props: any): void {
+  // check the type of each property
+  if (typeof props.mode !== "string") {
+    throw new Error("OneSignal Expo Plugin: 'mode' must be a string.");
+  }
+
+  if (props.devTeam && typeof props.devTeam !== "string") {
+    throw new Error("OneSignal Expo Plugin: 'devTeam' must be a string.");
+  }
+
+  if (props.iPhoneDeploymentTarget && typeof props.iPhoneDeploymentTarget !== "string") {
+    throw new Error("OneSignal Expo Plugin: 'iPhoneDeploymentTarget' must be a string.");
+  }
+
+  if (props.smallIcons && !Array.isArray(props.smallIcons)) {
+    throw new Error("OneSignal Expo Plugin: 'smallIcons' must be an array.");
+  }
+
+  if (props.smallIconAccentColor && typeof props.smallIconAccentColor !== "string") {
+    throw new Error("OneSignal Expo Plugin: 'smallIconAccentColor' must be a string.");
+  }
+
+  if (props.largeIcons && !Array.isArray(props.largeIcons)) {
+    throw new Error("OneSignal Expo Plugin: 'largeIcons' must be an array.");
+  }
+
+  if (props.iosNSEFilePath && typeof props.iosNSEFilePath !== "string") {
+    throw new Error("OneSignal Expo Plugin: 'iosNSEFilePath' must be a string.");
+  }
+
+  // check for extra properties
+  const inputProps = Object.keys(props);
+
+  for (const prop of inputProps) {
+    if (!ONESIGNAL_PLUGIN_PROPS.includes(prop)) {
+      throw new Error(`OneSignal Expo Plugin: You have provided an invalid property "${prop}" to the OneSignal plugin.`);
+    }
+  }
+}

package/types/types.ts

@@ -8,15 +8,15 @@
   mode: Mode;
 
   /**
-   * (optional) Used to configure Apple Team ID. You can find your Apple Team ID by running expo credentials:manager e.g: "91SW8A37CR" 
+   * (optional) Used to configure Apple Team ID. You can find your Apple Team ID by running expo credentials:manager e.g: "91SW8A37CR"
    */
-  devTeam: string;
+  devTeam?: string;
 
   /**
    * (optional) Target IPHONEOS_DEPLOYMENT_TARGET value to be used when adding the iOS NSE. 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".
    */
-  iPhoneDeploymentTarget: string;
+  iPhoneDeploymentTarget?: string;
 
   /**
    * (optional) The small notification icons for Android.  Images will be automatically scaled up/down, the recommended size
@@ -24,6 +24,11 @@
    */
   smallIcons?:            string[];
 
+  /**
+   * (optional) The accent color to use for notification icons on Android. Must be a valid Android color resource, for example: "#FF0000"
+   */
+  smallIconAccentColor?:  string;
+
   /**
    * (optional) The large notification icons for Android. Images will be automatically scaled up/down to 256x256.
    */
@@ -37,6 +42,16 @@
    iosNSEFilePath?:       string;
 };
 
+export const ONESIGNAL_PLUGIN_PROPS: string[] = [
+  "mode",
+  "devTeam",
+  "iPhoneDeploymentTarget",
+  "smallIcons",
+  "largeIcons",
+  "iosNSEFilePath",
+  "smallIconAccentColor"
+];
+
 export enum Mode {
   Dev = "development",
   Prod = "production"