onesignal-expo-plugin 2.3.0 → 2.4.0

package/README.md

@@ -81,7 +81,7 @@ You can pass props to the plugin config object to configure:
 | Plugin Prop              |              |                                                                                                                                                                                                                                                                                                                                                                               |
 | ------------------------ | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `mode`                   | **required** | Used to configure [APNs environment](https://developer.apple.com/documentation/bundleresources/entitlements/aps-environment) entitlement. `"development"` or `"production"`                                                                                                                                                                                                   |
-| `devTeam`                | optional     | Used to configure Apple Team ID. You can find your Apple Team ID by running `expo credentials:manager` e.g: `"91SW8A37CR"`                                                                                                                                                                                                                                                    |
+| `devTeam`                | **deprecated** | Use [`ios.appleTeamId`](https://docs.expo.dev/versions/latest/config/app/#appleteamid) in your Expo config instead. Falls back to this value if `appleTeamId` is not set. e.g: `"91SW8A37CR"`                                                                                                                                                                              |
 | `iPhoneDeploymentTarget` | optional     | Target `IPHONEOS_DEPLOYMENT_TARGET` value to be used when adding the iOS [NSE](https://documentation.onesignal.com/docs/service-extensions). A deployment target is nothing more than the minimum version of the operating system the application can run on. This value should match the value in your Podfile e.g: `"12.0"`.                                                |
 | `smallIcons`             | optional     | An array of local paths to small notification icons for Android. Image should be white, transparent, and 96x96 in size. Input images will be automatically scaled down and placed in the appropriate resource folders. e.g: `["./assets/ic_stat_onesignal_default.png"]`. See https://documentation.onesignal.com/docs/customize-notification-icons#small-notification-icons. |
 | `largeIcons`             | optional     | An array of local paths to large notification icons for Android. Image should be white, transparent, and 256x256 in size. e.g: `["./assets/ic_onesignal_large_icon_default.png"]`. See https://documentation.onesignal.com/docs/customize-notification-icons#large-notification-icons.                                                                                        |
@@ -89,6 +89,8 @@ You can pass props to the plugin config object to configure:
 | `iosNSEFilePath`         | optional     | The local path to a custom Notification Service Extension (NSE), written in Objective-C. The NSE will typically start as a copy of the [default NSE](https://github.com/OneSignal/onesignal-expo-plugin/blob/main/support/serviceExtensionFiles/NotificationService.m), then altered to support any custom logic required. e.g: `"./assets/NotificationService.m"`.           |
 | `appGroupName`           | optional     | Used to configure a custom iOS [App Group](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-create-an-app-group) name. If not provided, defaults to `"group.{ios.bundleIdentifier}.onesignal"`. e.g: `"group.com.example.myapp.onesignal2"`. |
 | `nseBundleIdentifier`    | optional     | Used to configure a custom bundle identifier suffix for the iOS Notification Service Extension. The full bundle identifier will be `"{ios.bundleIdentifier}.{nseBundleIdentifier}"`. If not provided, defaults to `"OneSignalNotificationServiceExtension"`. |
+| `disableNSE`             | optional     | If `true`, the iOS Notification Service Extension (NSE) will not be added to the project. The NSE is required for badges, confirmed delivery, media attachments, and action buttons. Only disable this if you only need basic push notifications. |
+| `sounds`                 | optional     | An array of local paths to custom notification sound files (`.wav` only, ≤30 seconds). Files are copied into the app bundle on iOS and `res/raw/` on Android. e.g: `["./assets/notification_sound.wav"]`. See https://documentation.onesignal.com/docs/customize-notification-sounds. |
 
 ### OneSignal App ID
 

package/build/onesignal/withOneSignalAndroid.js

@@ -8,6 +8,7 @@ exports.withOneSignalAndroid = void 0;
 const config_plugins_1 = require("@expo/config-plugins");
 const image_utils_1 = require("@expo/image-utils");
 const OneSignalLog_1 = require("../support/OneSignalLog");
+const helpers_1 = require("../support/helpers");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const RESOURCE_ROOT_PATH = 'android/app/src/main/res/';
@@ -61,18 +62,20 @@ const withSmallIconAccentColor = (config, onesignalProps) => {
         return config;
     }
     return (0, config_plugins_1.withStringsXml)(config, (config) => {
-        const colorInARGB = `FF${onesignalProps.smallIconAccentColor?.replace('#', '')}`;
+        const colorInARGB = (0, helpers_1.parseColorToARGB)(onesignalProps.smallIconAccentColor ?? '');
         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];
+        const existingIndex = strings.findIndex((stringEntry) => stringEntry.$?.name === 'onesignal_notification_accent_color');
+        const accentColorEntry = {
+            $: { name: 'onesignal_notification_accent_color' },
+            _: colorInARGB,
+        };
+        if (existingIndex !== -1) {
+            strings[existingIndex] = accentColorEntry;
         }
+        else {
+            strings.push(accentColorEntry);
+        }
+        config.modResults.resources.string = strings;
         return config;
     });
 };
@@ -101,26 +104,33 @@ async function saveIconAsync(icon, projectRoot, dirsToSize, outputName) {
         (0, fs_1.writeFileSync)((0, path_1.resolve)(path, name + '.png'), resizedIcon);
     }
 }
-const OKHTTP_FORCE_FIX = `
-subprojects {
-    project.configurations.all {
-        resolutionStrategy.force 'com.squareup.okhttp3:okhttp:4.12.0'
+const withSoundFiles = (config, onesignalProps) => {
+    if (!onesignalProps.sounds) {
+        return config;
     }
-}`;
-const withOkHttpFix = (config) => {
-    return (0, config_plugins_1.withProjectBuildGradle)(config, (config) => {
-        if (config.modResults.contents.includes("force 'com.squareup.okhttp3:okhttp:4.12.0'")) {
+    return (0, config_plugins_1.withDangerousMod)(config, [
+        'android',
+        async (config) => {
+            const projectRoot = config.modRequest.projectRoot;
+            const rawDir = (0, path_1.resolve)(projectRoot, RESOURCE_ROOT_PATH, 'raw');
+            if (!(0, fs_1.existsSync)(rawDir)) {
+                (0, fs_1.mkdirSync)(rawDir, { recursive: true });
+            }
+            for (const soundFile of onesignalProps.sounds) {
+                const sourcePath = (0, path_1.resolve)(projectRoot, soundFile);
+                const fileName = (0, path_1.basename)(sourcePath).toLowerCase();
+                OneSignalLog_1.OneSignalLog.log(`Copying sound file ${soundFile} to res/raw/${fileName}`);
+                (0, fs_1.copyFileSync)(sourcePath, (0, path_1.resolve)(rawDir, fileName));
+            }
             return config;
-        }
-        config.modResults.contents += OKHTTP_FORCE_FIX;
-        return config;
-    });
+        },
+    ]);
 };
 const withOneSignalAndroid = (config, props) => {
     config = withSmallIcons(config, props);
     config = withLargeIcons(config, props);
     config = withSmallIconAccentColor(config, props);
-    config = withOkHttpFix(config);
+    config = withSoundFiles(config, props);
     return config;
 };
 exports.withOneSignalAndroid = withOneSignalAndroid;

package/build/onesignal/withOneSignalIos.d.ts

@@ -4,4 +4,10 @@
  */
 import { ConfigPlugin } from '@expo/config-plugins';
 import { OneSignalPluginProps } from '../types/types';
+import { ExpoConfig } from '@expo/config-types';
+/**
+ * Resolve the Apple development team ID. Prefers `ios.appleTeamId` from the
+ * Expo config, falling back to the plugin's deprecated `devTeam` prop.
+ */
+export declare function resolveDevTeam(config: ExpoConfig, props: OneSignalPluginProps): string | undefined;
 export declare const withOneSignalIos: ConfigPlugin<OneSignalPluginProps>;

package/build/onesignal/withOneSignalIos.js

@@ -41,6 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withOneSignalIos = void 0;
+exports.resolveDevTeam = resolveDevTeam;
 const config_plugins_1 = require("@expo/config-plugins");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
@@ -165,10 +166,30 @@ const withOneSignalNSE = (config, props) => {
         },
     ]);
 };
+/**
+ * Resolve the Apple development team ID. Prefers `ios.appleTeamId` from the
+ * Expo config, falling back to the plugin's deprecated `devTeam` prop.
+ */
+function resolveDevTeam(config, props) {
+    if (config.ios?.appleTeamId) {
+        if (props.devTeam) {
+            OneSignalLog_1.OneSignalLog.log('Warning: Both "ios.appleTeamId" and the deprecated "devTeam" plugin prop are set. ' +
+                '"devTeam" will be ignored. Remove "devTeam" from your plugin config.');
+        }
+        return config.ios.appleTeamId;
+    }
+    if (props.devTeam) {
+        OneSignalLog_1.OneSignalLog.log('Warning: The "devTeam" plugin prop is deprecated and will be removed in a future major release. ' +
+            'Set "ios.appleTeamId" in your Expo config instead.');
+        return props.devTeam;
+    }
+    return undefined;
+}
 const withOneSignalXcodeProject = (config, props) => {
     return (0, config_plugins_1.withXcodeProject)(config, (newConfig) => {
         const xcodeProject = newConfig.modResults;
         const nseBundleId = `${config.ios?.bundleIdentifier}.${props.nseBundleIdentifier ?? iosConstants_1.NSE_TARGET_NAME}`;
+        const devTeam = resolveDevTeam(config, props);
         if (xcodeProject.pbxTargetByName(iosConstants_1.NSE_TARGET_NAME)) {
             OneSignalLog_1.OneSignalLog.log(`${iosConstants_1.NSE_TARGET_NAME} already exists in project. Skipping...`);
             return newConfig;
@@ -208,7 +229,7 @@ const withOneSignalXcodeProject = (config, props) => {
             if (typeof configurations[key].buildSettings !== 'undefined' &&
                 configurations[key].buildSettings.PRODUCT_NAME == `"${iosConstants_1.NSE_TARGET_NAME}"`) {
                 const buildSettingsObj = configurations[key].buildSettings;
-                buildSettingsObj.DEVELOPMENT_TEAM = props?.devTeam;
+                buildSettingsObj.DEVELOPMENT_TEAM = devTeam;
                 buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET =
                     props?.iPhoneDeploymentTarget ?? iosConstants_1.IPHONEOS_DEPLOYMENT_TARGET;
                 buildSettingsObj.TARGETED_DEVICE_FAMILY = iosConstants_1.TARGETED_DEVICE_FAMILY;
@@ -217,11 +238,39 @@ const withOneSignalXcodeProject = (config, props) => {
             }
         }
         // Add development teams to both your target and the original project
-        xcodeProject.addTargetAttribute('DevelopmentTeam', props?.devTeam, nseTarget);
-        xcodeProject.addTargetAttribute('DevelopmentTeam', props?.devTeam);
+        xcodeProject.addTargetAttribute('DevelopmentTeam', devTeam, nseTarget);
+        xcodeProject.addTargetAttribute('DevelopmentTeam', devTeam);
         return newConfig;
     });
 };
+const withSoundFiles = (config, onesignalProps) => {
+    if (!onesignalProps.sounds) {
+        return config;
+    }
+    return (0, config_plugins_1.withXcodeProject)(config, (config) => {
+        const projectRoot = config.modRequest.projectRoot;
+        const projectName = config.modRequest.projectName;
+        const sourceRoot = config_plugins_1.IOSConfig.Paths.getSourceRoot(projectRoot);
+        let project = config.modResults;
+        for (const soundFile of onesignalProps.sounds) {
+            const fileName = path.basename(soundFile);
+            const sourcePath = path.resolve(projectRoot, soundFile);
+            const destPath = path.resolve(sourceRoot, fileName);
+            OneSignalLog_1.OneSignalLog.log(`Copying sound file ${soundFile} to iOS project`);
+            fs.copyFileSync(sourcePath, destPath);
+            if (!project.hasFile(`${projectName}/${fileName}`)) {
+                project = config_plugins_1.IOSConfig.XcodeUtils.addResourceFileToGroup({
+                    filepath: `${projectName}/${fileName}`,
+                    groupName: projectName,
+                    project,
+                    isBuildFile: true,
+                });
+            }
+        }
+        config.modResults = project;
+        return config;
+    });
+};
 const withOneSignalIos = (config, props) => {
     config = withAppEnvironment(config, props);
     config = withRemoteNotificationsPermissions(config, props);
@@ -233,6 +282,7 @@ const withOneSignalIos = (config, props) => {
         config = withOneSignalXcodeProject(config, props);
         config = withEasManagedCredentials(config, props);
     }
+    config = withSoundFiles(config, props);
     return config;
 };
 exports.withOneSignalIos = withOneSignalIos;

package/build/support/helpers.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Converts a hex color string (#RGB, #RRGGBB, or #AARRGGBB) to an
+ * 8-character ARGB hex string (no '#') expected by the OneSignal Android SDK.
+ */
+export declare function parseColorToARGB(color: string): string;
 export declare function validatePluginProps(props: any): void;
 export declare function getAppGroupIdentifier(bundleIdentifier: string, customAppGroupName?: string): string;

package/build/support/helpers.js

@@ -1,8 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseColorToARGB = parseColorToARGB;
 exports.validatePluginProps = validatePluginProps;
 exports.getAppGroupIdentifier = getAppGroupIdentifier;
+const path_1 = require("path");
 const types_1 = require("../types/types");
+const HEX_COLOR_6_REGEX = /^#?[0-9A-Fa-f]{6}$/;
+const HEX_COLOR_8_REGEX = /^#?[0-9A-Fa-f]{8}$/;
+/**
+ * Converts a hex color string (#RGB, #RRGGBB, or #AARRGGBB) to an
+ * 8-character ARGB hex string (no '#') expected by the OneSignal Android SDK.
+ */
+function parseColorToARGB(color) {
+    const hex = color.replace('#', '');
+    if (HEX_COLOR_8_REGEX.test(hex)) {
+        return hex.toUpperCase();
+    }
+    if (HEX_COLOR_6_REGEX.test(hex)) {
+        return `FF${hex.toUpperCase()}`;
+    }
+    if (/^[0-9A-Fa-f]{3}$/.test(hex)) {
+        const expanded = hex
+            .split('')
+            .map((c) => c + c)
+            .join('');
+        return `FF${expanded.toUpperCase()}`;
+    }
+    throw new Error(`OneSignal Expo Plugin: 'smallIconAccentColor' must be a valid hex color (e.g. "#FF0000"), got "${color}".`);
+}
 function validatePluginProps(props) {
     // check the type of each property
     if (typeof props.mode !== 'string') {
@@ -18,9 +43,11 @@ function validatePluginProps(props) {
     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.smallIconAccentColor != null) {
+        if (typeof props.smallIconAccentColor !== 'string') {
+            throw new Error("OneSignal Expo Plugin: 'smallIconAccentColor' must be a string.");
+        }
+        parseColorToARGB(props.smallIconAccentColor);
     }
     if (props.largeIcons && !Array.isArray(props.largeIcons)) {
         throw new Error("OneSignal Expo Plugin: 'largeIcons' must be an array.");
@@ -38,6 +65,19 @@ function validatePluginProps(props) {
     if (props.disableNSE !== undefined && typeof props.disableNSE !== 'boolean') {
         throw new Error("OneSignal Expo Plugin: 'disableNSE' must be a boolean.");
     }
+    if (props.sounds !== undefined) {
+        if (!Array.isArray(props.sounds)) {
+            throw new Error("OneSignal Expo Plugin: 'sounds' must be an array.");
+        }
+        for (const sound of props.sounds) {
+            if (typeof sound !== 'string') {
+                throw new Error("OneSignal Expo Plugin: each entry in 'sounds' must be a string path.");
+            }
+            if ((0, path_1.extname)(sound).toLowerCase() !== '.wav') {
+                throw new Error(`OneSignal Expo Plugin: sound file "${sound}" must be a .wav file. Only .wav is supported (works on both iOS and Android).`);
+            }
+        }
+    }
     // check for extra properties
     const inputProps = Object.keys(props);
     for (const prop of inputProps) {

package/build/types/types.d.ts

@@ -8,6 +8,7 @@ export type OneSignalPluginProps = {
     mode: 'development' | 'production';
     /**
      * (optional) Used to configure Apple Team ID. You can find your Apple Team ID by running expo credentials:manager e.g: "91SW8A37CR"
+     * @deprecated Use `ios.appleTeamId` in your Expo config instead. This prop will be removed in a future major release.
      */
     devTeam?: string;
     /**
@@ -51,5 +52,11 @@ export type OneSignalPluginProps = {
      * Only disable if you only need basic push notifications.
      */
     disableNSE?: boolean;
+    /**
+     * (optional) An array of local paths to custom notification sound files (.wav only).
+     * Files are added to the iOS app bundle and Android res/raw/.
+     * @see https://documentation.onesignal.com/docs/customize-notification-sounds
+     */
+    sounds?: string[];
 };
 export declare const ONESIGNAL_PLUGIN_PROPS: string[];

package/build/types/types.js

@@ -12,4 +12,5 @@ exports.ONESIGNAL_PLUGIN_PROPS = [
     'appGroupName',
     'nseBundleIdentifier',
     'disableNSE',
+    'sounds',
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Some Changez",
   "main": "./app.plugin.js",
   "types": "./build/types/types.d.ts",