onesignal-expo-plugin 2.2.0 → 2.3.0

package/build/onesignal/withOneSignal.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Expo config plugin for One Signal
+ * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
+ */
+import { ConfigPlugin } from '@expo/config-plugins';
+import { OneSignalPluginProps } from '../types/types';
+declare const withOneSignal: ConfigPlugin<OneSignalPluginProps>;
+export default withOneSignal;

package/build/onesignal/withOneSignalAndroid.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Expo config plugin for OneSignal (Android)
+ * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
+ */
+import { ConfigPlugin } from '@expo/config-plugins';
+import { OneSignalPluginProps } from '../types/types';
+export declare const withOneSignalAndroid: ConfigPlugin<OneSignalPluginProps>;

package/build/onesignal/withOneSignalAndroid.js

@@ -23,34 +23,34 @@ const SMALL_ICON_DIRS_TO_SIZE = {
 const LARGE_ICON_DIRS_TO_SIZE = {
     'drawable-xxxhdpi': 256,
 };
+const SMALL_ICON_DEFAULT_NAME = 'ic_stat_onesignal_default';
 const withSmallIcons = (config, onesignalProps) => {
     if (!onesignalProps.smallIcons && !config.notification?.icon) {
         return config;
     }
-    // we are modifying the android build (adding files) without a base mod
     return (0, config_plugins_1.withDangerousMod)(config, [
         'android',
         async (config) => {
             if (config.notification?.icon) {
-                await saveIconAsync(config.notification.icon, config.modRequest.projectRoot, SMALL_ICON_DIRS_TO_SIZE);
+                await saveIconAsync(config.notification.icon, config.modRequest.projectRoot, SMALL_ICON_DIRS_TO_SIZE, SMALL_ICON_DEFAULT_NAME);
             }
             if (onesignalProps.smallIcons) {
-                await saveIconsArrayAsync(config.modRequest.projectRoot, onesignalProps.smallIcons, SMALL_ICON_DIRS_TO_SIZE);
+                await saveIconsArrayAsync(config.modRequest.projectRoot, onesignalProps.smallIcons, SMALL_ICON_DIRS_TO_SIZE, SMALL_ICON_DEFAULT_NAME);
             }
             return config;
         },
     ]);
 };
+const LARGE_ICON_DEFAULT_NAME = 'ic_onesignal_large_icon_default';
 const withLargeIcons = (config, onesignalProps) => {
     if (!onesignalProps.largeIcons) {
         return config;
     }
-    // we are modifying the android build (adding files) without a base mod
     return (0, config_plugins_1.withDangerousMod)(config, [
         'android',
         async (config) => {
             if (onesignalProps.largeIcons) {
-                await saveIconsArrayAsync(config.modRequest.projectRoot, onesignalProps.largeIcons, LARGE_ICON_DIRS_TO_SIZE);
+                await saveIconsArrayAsync(config.modRequest.projectRoot, onesignalProps.largeIcons, LARGE_ICON_DIRS_TO_SIZE, LARGE_ICON_DEFAULT_NAME);
             }
             return config;
         },
@@ -76,13 +76,15 @@ const withSmallIconAccentColor = (config, onesignalProps) => {
         return config;
     });
 };
-async function saveIconsArrayAsync(projectRoot, icons, dirsToSize) {
-    for (const icon of icons) {
-        await saveIconAsync(icon, projectRoot, dirsToSize);
+async function saveIconsArrayAsync(projectRoot, icons, dirsToSize, defaultName) {
+    for (let i = 0; i < icons.length; i++) {
+        // the first icon should use OneSignal’s required default drawable name; others keep their file-derived names.
+        const outputName = i === 0 ? defaultName : undefined;
+        await saveIconAsync(icons[i], projectRoot, dirsToSize, outputName);
     }
 }
-async function saveIconAsync(icon, projectRoot, dirsToSize) {
-    const name = (0, path_1.parse)(icon).name;
+async function saveIconAsync(icon, projectRoot, dirsToSize, outputName) {
+    const name = outputName ?? (0, path_1.parse)(icon).name;
     OneSignalLog_1.OneSignalLog.log('Saving icon ' + icon + ' as drawable resource ' + name);
     for (const iconResourceDir in dirsToSize) {
         const path = (0, path_1.resolve)(projectRoot, RESOURCE_ROOT_PATH, iconResourceDir);
@@ -99,10 +101,26 @@ async function saveIconAsync(icon, projectRoot, dirsToSize) {
         (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 withOkHttpFix = (config) => {
+    return (0, config_plugins_1.withProjectBuildGradle)(config, (config) => {
+        if (config.modResults.contents.includes("force 'com.squareup.okhttp3:okhttp:4.12.0'")) {
+            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);
     return config;
 };
 exports.withOneSignalAndroid = withOneSignalAndroid;

package/build/onesignal/withOneSignalIos.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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
+ */
+import { ConfigPlugin } from '@expo/config-plugins';
+import { OneSignalPluginProps } from '../types/types';
+export declare const withOneSignalIos: ConfigPlugin<OneSignalPluginProps>;

package/build/onesignal/withOneSignalIos.js

@@ -50,7 +50,6 @@ const updatePodfile_1 = require("../support/updatePodfile");
 const NseUpdaterManager_1 = __importDefault(require("../support/NseUpdaterManager"));
 const OneSignalLog_1 = require("../support/OneSignalLog");
 const FileManager_1 = require("../support/FileManager");
-const assert_1 = __importDefault(require("assert"));
 const getEasManagedCredentialsConfigExtra_1 = __importDefault(require("../support/eas/getEasManagedCredentialsConfigExtra"));
 /**
  * Add 'aps-environment' record with current environment to '<project-name>.entitlements' file
@@ -118,7 +117,9 @@ const withCustomAppGroupsKey = (config, props) => {
     });
 };
 const withEasManagedCredentials = (config, props) => {
-    (0, assert_1.default)(config.ios?.bundleIdentifier, "Missing 'ios.bundleIdentifier' in app config.");
+    if (!config.ios?.bundleIdentifier) {
+        return config;
+    }
     config.extra = (0, getEasManagedCredentialsConfigExtra_1.default)(config, props?.appGroupName, props?.nseBundleIdentifier);
     return config;
 };
@@ -133,12 +134,12 @@ const withOneSignalPodfile = (config) => {
     ]);
 };
 const withOneSignalNSE = (config, props) => {
-    // support for monorepos where node_modules can be above the project directory.
-    const pluginDir = require.resolve('onesignal-expo-plugin/package.json');
-    const sourceDir = path.join(pluginDir, '../build/support/serviceExtensionFiles/');
     return (0, config_plugins_1.withDangerousMod)(config, [
         'ios',
         async (config) => {
+            // support for monorepos where node_modules can be above the project directory.
+            const pluginDir = require.resolve('onesignal-expo-plugin/package.json');
+            const sourceDir = path.join(pluginDir, '../build/support/serviceExtensionFiles/');
             const iosPath = path.join(config.modRequest.projectRoot, 'ios');
             /* COPY OVER EXTENSION FILES */
             fs.mkdirSync(`${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`, {
@@ -224,12 +225,14 @@ const withOneSignalXcodeProject = (config, props) => {
 const withOneSignalIos = (config, props) => {
     config = withAppEnvironment(config, props);
     config = withRemoteNotificationsPermissions(config, props);
-    config = withCustomAppGroupsKey(config, props);
-    config = withAppGroupPermissions(config, props);
-    config = withOneSignalPodfile(config, props);
-    config = withOneSignalNSE(config, props);
-    config = withOneSignalXcodeProject(config, props);
-    config = withEasManagedCredentials(config, props);
+    if (!props.disableNSE) {
+        config = withCustomAppGroupsKey(config, props);
+        config = withAppGroupPermissions(config, props);
+        config = withOneSignalPodfile(config, props);
+        config = withOneSignalNSE(config, props);
+        config = withOneSignalXcodeProject(config, props);
+        config = withEasManagedCredentials(config, props);
+    }
     return config;
 };
 exports.withOneSignalIos = withOneSignalIos;

package/build/support/FileManager.d.ts

@@ -0,0 +1,9 @@
+/**
+ * FileManager contains static *awaitable* file-system functions
+ */
+export declare class FileManager {
+    static readFile(path: string): Promise<string>;
+    static writeFile(path: string, contents: string): Promise<void>;
+    static copyFile(path1: string, path2: string): Promise<void>;
+    static dirExists(path: string): boolean;
+}

package/build/support/NseUpdaterManager.d.ts

@@ -0,0 +1,8 @@
+export default class NseUpdaterManager {
+    private nsePath;
+    constructor(iosPath: string);
+    updateNSEEntitlements(groupIdentifier: string): Promise<void>;
+    updateNSEBundleVersion(version: string): Promise<void>;
+    updateNSEBundleShortVersion(version: string): Promise<void>;
+    updateNSEInfoPlistAppGroupKey(appGroupName: string): Promise<void>;
+}

package/build/support/OneSignalLog.d.ts

@@ -0,0 +1,4 @@
+export declare class OneSignalLog {
+    static log(str: string): void;
+    static error(str: string): void;
+}

package/build/support/eas/getEasManagedCredentialsConfigExtra.d.ts

@@ -0,0 +1,4 @@
+import { ExpoConfig } from '@expo/config-types';
+export default function getEasManagedCredentialsConfigExtra(config: ExpoConfig, appGroupName?: string, nseBundleIdentifier?: string): {
+    [k: string]: any;
+};

package/build/support/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare function validatePluginProps(props: any): void;
+export declare function getAppGroupIdentifier(bundleIdentifier: string, customAppGroupName?: string): string;

package/build/support/helpers.js

@@ -35,6 +35,9 @@ function validatePluginProps(props) {
         typeof props.nseBundleIdentifier !== 'string') {
         throw new Error("OneSignal Expo Plugin: 'nseBundleIdentifier' must be a string.");
     }
+    if (props.disableNSE !== undefined && typeof props.disableNSE !== 'boolean') {
+        throw new Error("OneSignal Expo Plugin: 'disableNSE' must be a boolean.");
+    }
     // check for extra properties
     const inputProps = Object.keys(props);
     for (const prop of inputProps) {

package/build/support/iosConstants.d.ts

@@ -0,0 +1,12 @@
+export declare const IPHONEOS_DEPLOYMENT_TARGET = "11.0";
+export declare const TARGETED_DEVICE_FAMILY = "\"1,2\"";
+export declare const GROUP_IDENTIFIER_TEMPLATE_REGEX: RegExp;
+export declare const BUNDLE_SHORT_VERSION_TEMPLATE_REGEX: RegExp;
+export declare const BUNDLE_VERSION_TEMPLATE_REGEX: RegExp;
+export declare const DEFAULT_BUNDLE_VERSION = "1";
+export declare const DEFAULT_BUNDLE_SHORT_VERSION = "1.0";
+export declare const NSE_TARGET_NAME = "OneSignalNotificationServiceExtension";
+export declare const NSE_SOURCE_FILE = "NotificationService.m";
+export declare const NSE_PODFILE_SNIPPET = "\ntarget 'OneSignalNotificationServiceExtension' do\n  pod 'OneSignalXCFramework', '>= 5.0', '< 6.0'\n  use_frameworks! :linkage => podfile_properties['ios.useFrameworks'].to_sym if podfile_properties['ios.useFrameworks']\nend";
+export declare const NSE_PODFILE_REGEX: RegExp;
+export declare const NSE_EXT_FILES: string[];

package/build/support/serviceExtensionFiles/NotificationService.m

@@ -4,26 +4,31 @@
 
 @interface NotificationService ()
 
-@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
-@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
-@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;
+@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)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);
+  [OneSignal serviceExtensionTimeWillExpireRequest:self.receivedRequest
+                    withMutableNotificationContent:self.bestAttemptContent];
+  self.contentHandler(self.bestAttemptContent);
 }
 
 @end

package/build/support/updatePodfile.d.ts

@@ -0,0 +1 @@
+export declare function updatePodfile(iosPath: string): Promise<void>;

package/build/types/types.d.ts

@@ -0,0 +1,55 @@
+/**
+ * OneSignalPluginProps refer to the properties set by the user in their app config file (e.g: app.json)
+ */
+export type OneSignalPluginProps = {
+    /**
+     * (required) Used to configure APNs environment entitlement. "development" or "production"
+     */
+    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"
+     */
+    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;
+    /**
+     * (optional) The small notification icons for Android.  Images will be automatically scaled up/down, the recommended size
+     * is 96x96 to always scale down.
+     */
+    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.
+     */
+    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;
+    /**
+     * (optional) Used to configure a custom iOS app group name. If not provided, defaults to "group.{ios.bundleIdentifier}.onesignal".
+     * @see https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-create-an-app-group
+     */
+    appGroupName?: string;
+    /**
+     * (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".
+     */
+    nseBundleIdentifier?: string;
+    /**
+     * (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 if you only need basic push notifications.
+     */
+    disableNSE?: boolean;
+};
+export declare const ONESIGNAL_PLUGIN_PROPS: string[];

package/build/types/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mode = exports.ONESIGNAL_PLUGIN_PROPS = void 0;
+exports.ONESIGNAL_PLUGIN_PROPS = void 0;
 exports.ONESIGNAL_PLUGIN_PROPS = [
     'mode',
     'devTeam',
@@ -11,9 +11,5 @@ exports.ONESIGNAL_PLUGIN_PROPS = [
     'smallIconAccentColor',
     'appGroupName',
     'nseBundleIdentifier',
+    'disableNSE',
 ];
-var Mode;
-(function (Mode) {
-    Mode["Dev"] = "development";
-    Mode["Prod"] = "production";
-})(Mode || (exports.Mode = Mode = {}));

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Some Changez",
   "main": "./app.plugin.js",
+  "types": "./build/types/types.d.ts",
   "files": [
     "build",
     "app.plugin.js"
@@ -10,11 +11,15 @@
   "scripts": {
     "test": "bun test",
     "test:coverage": "bun test --coverage",
-    "build": "bun run lint && rm -rf build && tsc && cp -a src/support/serviceExtensionFiles build/support/",
-    "format:check": "prettier --check \"**/*.{ts,tsx}\" --ignore-path .prettierignore",
-    "format:fix": "prettier --write \"**/*.{ts,tsx}\" --ignore-path .prettierignore",
+    "build": "rm -rf build && tsc && cp -a src/support/serviceExtensionFiles build/support/",
+    "format:spotless": "./examples/demo/android/gradlew spotlessApply",
+    "format:prettier": "prettier --write \"**/*.{ts,tsx}\" --ignore-path .gitignore",
+    "format": "concurrently \"bun run format:spotless\" \"bun run format:prettier\"",
+    "format:check:spotless": "./examples/demo/android/gradlew spotlessCheck",
+    "format:check:prettier": "prettier --check \"**/*.{ts,tsx}\" --ignore-path .gitignore",
+    "format:check": "concurrently \"bun run format:check:spotless\" \"bun run format:check:prettier\"",
     "lint": "oxlint src examples && bun run format:check",
-    "lint:fix": "oxlint src examples --fix && bun run format:fix"
+    "lint:fix": "oxlint src examples --fix && bun run format"
   },
   "repository": {
     "type": "git",
@@ -42,6 +47,7 @@
   "homepage": "https://github.com/OneSignal/onesignal-expo-plugin#readme",
   "devDependencies": {
     "@types/bun": "^1.3.9",
+    "concurrently": "^9.2.1",
     "expo-module-scripts": "^5.0.8",
     "oxlint": "^1.43.0",
     "prettier": "^3.8.1",