onesignal-expo-plugin 2.6.0 → 2.7.0

package/README.md

@@ -89,9 +89,18 @@ You can pass props to the plugin config object to configure:
 | `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.                                                                                                                             |
+| `disableLocation`        | optional       | If `true`, the native OneSignal location module will be excluded from iOS and Android builds. Use this if your app does not call `OneSignal.Location` and should not link native location APIs.                                                                                                                                                                               |
 | `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.                                                                                         |
 | `liveActivities`         | optional       | Opt in to scaffolding an iOS Widget Extension target for OneSignal Live Activities. Use `{}` for the default `OneSignalWidget` target, or pass `targetName`, `bundleIdentifierSuffix`, `widgetFilePath`, or `deploymentTarget` to customize it. See [Live Activities](#live-activities).                                                                                      |
 
+### Disabling Location
+
+When `disableLocation` is enabled, the plugin configures native dependency
+resolution so `react-native-onesignal` excludes the location module. On iOS, it
+writes the Podfile environment setting used during CocoaPods resolution. On
+Android, it writes `onesignal.disableLocation=true` to the generated Gradle
+properties.
+
 ### Live Activities
 
 Set `liveActivities` to an object to add the native iOS Widget Extension files and Podfile target required for OneSignal Live Activities.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { t as OneSignalPluginProps } from "./types-BKWSKFuI.js";
+import { t as OneSignalPluginProps } from "./types-1HFwNzon.js";
 import { ConfigPlugin } from "expo/config-plugins.js";
 
 //#region src/onesignal/withOneSignal.d.ts

package/dist/index.js

@@ -36,9 +36,10 @@ const NSE_PRINCIPAL_CLASS_TEMPLATE_REGEX = /{{NSE_PRINCIPAL_CLASS}}/gm;
 const NSE_TARGET_NAME = "OneSignalNotificationServiceExtension";
 /** Default Swift template shipped under serviceExtensionFiles/. */
 const NSE_SOURCE_FILE = "NotificationService.swift";
-const NSE_PODFILE_SNIPPET = `
+const onesignalExtensionPodDependencies = (disableLocation) => disableLocation ? ["pod 'OneSignalXCFramework/OneSignal', '>= 5.0', '< 6.0'", "pod 'OneSignalXCFramework/OneSignalInAppMessages', '>= 5.0', '< 6.0'"].join("\n  ") : "pod 'OneSignalXCFramework', '>= 5.0', '< 6.0'";
+const nsePodfileSnippet = (disableLocation = false) => `
 target '${NSE_TARGET_NAME}' do
-  pod 'OneSignalXCFramework', '>= 5.0', '< 6.0'
+  ${onesignalExtensionPodDependencies(disableLocation)}
   use_frameworks! :linkage => podfile_properties['ios.useFrameworks'].to_sym if podfile_properties['ios.useFrameworks']
 end`;
 const NSE_PODFILE_REGEX = new RegExp(`target '${NSE_TARGET_NAME}'`);
@@ -48,9 +49,9 @@ const LIVE_ACTIVITY_DEPLOYMENT_TARGET = "16.2";
 const LIVE_ACTIVITY_BUNDLE_FILE = "OneSignalWidgetBundle.swift";
 const LIVE_ACTIVITY_WIDGET_FILE = "OneSignalWidgetLiveActivity.swift";
 const LIVE_ACTIVITY_INFO_PLIST_FILE = `${LIVE_ACTIVITY_TARGET_NAME}-Info.plist`;
-const liveActivityPodfileSnippet = (targetName) => `
+const liveActivityPodfileSnippet = (targetName, disableLocation = false) => `
 target '${targetName}' do
-  pod 'OneSignalXCFramework', '>= 5.0', '< 6.0'
+  ${onesignalExtensionPodDependencies(disableLocation)}
   use_frameworks! :linkage => podfile_properties['ios.useFrameworks'].to_sym if podfile_properties['ios.useFrameworks']
 end`;
 const liveActivityPodfileRegex = (targetName) => new RegExp(`target '${targetName}'`);
@@ -79,6 +80,7 @@ const ONESIGNAL_PLUGIN_PROPS = [
 	"appGroupName",
 	"nseBundleIdentifier",
 	"disableNSE",
+	"disableLocation",
 	"sounds",
 	"liveActivities"
 ];
@@ -113,6 +115,7 @@ function validatePluginProps(props) {
 	if (props.appGroupName && typeof props.appGroupName !== "string") throw new Error("OneSignal Expo Plugin: 'appGroupName' must be a string.");
 	if (props.nseBundleIdentifier && typeof props.nseBundleIdentifier !== "string") throw new Error("OneSignal Expo Plugin: 'nseBundleIdentifier' must be a string.");
 	if (props.disableNSE !== void 0 && typeof props.disableNSE !== "boolean") throw new Error("OneSignal Expo Plugin: 'disableNSE' must be a boolean.");
+	if (props.disableLocation !== void 0 && typeof props.disableLocation !== "boolean") throw new Error("OneSignal Expo Plugin: 'disableLocation' must be a boolean.");
 	if (props.sounds !== void 0) {
 		if (!Array.isArray(props.sounds)) throw new Error("OneSignal Expo Plugin: 'sounds' must be an array.");
 		for (const sound of props.sounds) {
@@ -174,6 +177,7 @@ function resolveDevTeam(config, props) {
 * @see https://documentation.onesignal.com/docs/react-native-sdk-setup#step-4-install-for-ios-using-cocoapods-for-ios-apps
 */
 const RESOURCE_ROOT_PATH = "android/app/src/main/res/";
+const ONESIGNAL_DISABLE_LOCATION_GRADLE_PROPERTY = "onesignal.disableLocation";
 const SMALL_ICON_DIRS_TO_SIZE = {
 	"drawable-mdpi": 24,
 	"drawable-hdpi": 36,
@@ -217,6 +221,21 @@ const withSmallIconAccentColor = (config, onesignalProps) => {
 		return config;
 	});
 };
+const withLocationModuleGradleProperty = (config, onesignalProps) => {
+	if (onesignalProps.disableLocation == null) return config;
+	return (0, expo_config_plugins_js.withGradleProperties)(config, (config) => {
+		const properties = config.modResults;
+		const existingIndex = properties.findIndex((entry) => entry.type === "property" && entry.key === ONESIGNAL_DISABLE_LOCATION_GRADLE_PROPERTY);
+		const property = {
+			type: "property",
+			key: ONESIGNAL_DISABLE_LOCATION_GRADLE_PROPERTY,
+			value: onesignalProps.disableLocation ? "true" : "false"
+		};
+		if (existingIndex === -1) properties.push(property);
+		else properties[existingIndex] = property;
+		return config;
+	});
+};
 async function saveIconsArrayAsync(projectRoot, icons, dirsToSize, defaultName) {
 	for (let i = 0; i < icons.length; i++) {
 		const outputName = i === 0 ? defaultName : void 0;
@@ -261,6 +280,7 @@ const withOneSignalAndroid = (config, props) => {
 	config = withSmallIcons(config, props);
 	config = withLargeIcons(config, props);
 	config = withSmallIconAccentColor(config, props);
+	config = withLocationModuleGradleProperty(config, props);
 	config = withSoundFiles$1(config, props);
 	return config;
 };
@@ -384,14 +404,26 @@ var NseUpdaterManager = class {
 };
 //#endregion
 //#region src/support/updatePodfile.ts
-async function updatePodfile(iosPath) {
+const ONESIGNAL_DISABLE_LOCATION_ENV = "ENV['ONESIGNAL_DISABLE_LOCATION']";
+const ONESIGNAL_DISABLE_LOCATION_REGEX = /^(?:ENV\[['"]ONESIGNAL_DISABLE_LOCATION['"]\]\s*=\s*['"](true|false)['"]|\$OneSignalDisableLocation\s*=\s*(true|false))\s*$/m;
+async function updatePodfile(iosPath, disableLocation = false) {
 	if ((await FileManager.readFile(`${iosPath}/Podfile`)).match(NSE_PODFILE_REGEX)) {
 		OneSignalLog.log(`${NSE_TARGET_NAME} target already added to Podfile. Skipping...`);
 		return;
 	}
-	await fs_promises.default.appendFile(`${iosPath}/Podfile`, NSE_PODFILE_SNIPPET);
+	await fs_promises.default.appendFile(`${iosPath}/Podfile`, nsePodfileSnippet(disableLocation));
 	OneSignalLog.log(`${NSE_TARGET_NAME} target added to Podfile.`);
 }
+async function updatePodfileLocationModule(iosPath, disableLocation) {
+	const podfilePath = `${iosPath}/Podfile`;
+	const podfile = await FileManager.readFile(podfilePath);
+	const nextValue = `${ONESIGNAL_DISABLE_LOCATION_ENV} = '${disableLocation ? "true" : "false"}'`;
+	if (ONESIGNAL_DISABLE_LOCATION_REGEX.test(podfile)) {
+		await fs_promises.default.writeFile(podfilePath, podfile.replace(ONESIGNAL_DISABLE_LOCATION_REGEX, nextValue));
+		return;
+	}
+	await fs_promises.default.writeFile(podfilePath, `${nextValue}\n${podfile}`);
+}
 //#endregion
 //#region src/onesignal/withOneSignalLiveActivity.ts
 /**
@@ -435,7 +467,7 @@ const withLiveActivityPodfile = (config, props) => {
 			OneSignalLog.log(`${targetName} target already added to Podfile. Skipping...`);
 			return config;
 		}
-		await fs.promises.appendFile(podfilePath, liveActivityPodfileSnippet(targetName));
+		await fs.promises.appendFile(podfilePath, liveActivityPodfileSnippet(targetName, props.disableLocation === true));
 		OneSignalLog.log(`${targetName} target added to Podfile.`);
 		return config;
 	}]);
@@ -580,9 +612,17 @@ const withEasManagedCredentials = (config, props) => {
 	config.extra = getEasManagedCredentialsConfigExtra(config, props?.appGroupName, props?.nseBundleIdentifier, props?.liveActivities, props?.disableNSE);
 	return config;
 };
-const withOneSignalPodfile = (config) => {
+const withOneSignalPodfile = (config, props) => {
+	return (0, expo_config_plugins_js.withDangerousMod)(config, ["ios", async (config) => {
+		await updatePodfile(path.join(config.modRequest.projectRoot, "ios"), props.disableLocation === true);
+		return config;
+	}]);
+};
+const withLocationModulePodfile = (config, props) => {
+	const disableLocation = props.disableLocation;
+	if (disableLocation == null) return config;
 	return (0, expo_config_plugins_js.withDangerousMod)(config, ["ios", async (config) => {
-		await updatePodfile(path.join(config.modRequest.projectRoot, "ios"));
+		await updatePodfileLocationModule(path.join(config.modRequest.projectRoot, "ios"), disableLocation);
 		return config;
 	}]);
 };
@@ -685,6 +725,7 @@ const withSoundFiles = (config, onesignalProps) => {
 const withOneSignalIos = (config, props) => {
 	config = withAppEnvironment(config, props);
 	config = withRemoteNotificationsPermissions(config, props);
+	config = withLocationModulePodfile(config, props);
 	if (!props.disableNSE) {
 		config = withCustomAppGroupsKey(config, props);
 		config = withAppGroupPermissions(config, props);

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-import { t as OneSignalPluginProps } from "./types-BKWSKFuI.js";
+import { t as OneSignalPluginProps } from "./types-1HFwNzon.js";
 
 //#region package.json.d.ts
 declare let name: string;

package/dist/{types-BKWSKFuI.d.ts → types-1HFwNzon.d.ts}

@@ -79,6 +79,11 @@ type OneSignalPluginProps = {
    * Only disable if you only need basic push notifications.
    */
   disableNSE?: boolean;
+  /**
+   * (optional) If true, the native OneSignal location module will be excluded from iOS and Android builds.
+   * OneSignal.Location APIs will not collect location and will no-op or return false.
+   */
+  disableLocation?: 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/.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "OneSignal Expo config plugin for adding iOS and Android push notification support to managed Expo apps.",
   "keywords": [
     "EAS",