onesignal-expo-plugin 2.4.0 → 2.5.0

package/package.json

@@ -1,62 +1,60 @@
 {
   "name": "onesignal-expo-plugin",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Some Changez",
-  "main": "./app.plugin.js",
-  "types": "./build/types/types.d.ts",
-  "files": [
-    "build",
-    "app.plugin.js"
+  "keywords": [
+    "EAS",
+    "expo",
+    "notifications",
+    "onesignal",
+    "push"
   ],
-  "scripts": {
-    "test": "bun test",
-    "test:coverage": "bun test --coverage",
-    "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"
+  "homepage": "https://github.com/OneSignal/onesignal-expo-plugin#readme",
+  "bugs": {
+    "url": "https://github.com/OneSignal/onesignal-expo-plugin/issues"
   },
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/OneSignal/onesignal-expo-plugin.git"
   },
-  "keywords": [
-    "expo",
-    "onesignal",
-    "push",
-    "notifications",
-    "EAS"
-  ],
-  "author": "rgomezp",
-  "contributors": [
-    "Karen Grigoryan",
-    "Rodrigo Gomez-Palacio",
-    "Charlie Cruzan",
-    "Wojciech Kozyra",
-    "Brian Smith"
+  "files": [
+    "dist",
+    "serviceExtensionFiles",
+    "widgetExtensionFiles"
   ],
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/OneSignal/onesignal-expo-plugin/issues"
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "format:spotless": "./examples/demo/android/gradlew spotlessApply",
+    "format": "vp fmt && npm run format:spotless",
+    "format:check:spotless": "./examples/demo/android/gradlew spotlessCheck",
+    "format:check": "vp fmt --check && npm run format:check:spotless",
+    "lint": "vp check src && npm run format:check",
+    "lint:fix": "vp check --fix src && npm run format",
+    "test": "vp test"
+  },
+  "dependencies": {
+    "@expo/image-utils": "^0.8.8"
   },
-  "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",
-    "typescript": "^5.9.3"
+    "@expo/config-types": "^55.0.5",
+    "@types/node": "^22.19.3",
+    "@vitest/coverage-v8": "^4.1.5",
+    "typescript": "^6.0.3",
+    "vite-plus": "0.1.19"
   },
   "peerDependencies": {
+    "@expo/config-plugins": ">=7.0.0",
     "react-native-onesignal": ">=5.0.0"
   },
-  "dependencies": {
-    "@expo/image-utils": "^0.8.8"
-  }
+  "packageManager": "bun@1.3.13"
 }

package/serviceExtensionFiles/NotificationService.swift

@@ -0,0 +1,32 @@
+import UserNotifications
+import OneSignalExtension
+
+class NotificationService: UNNotificationServiceExtension {
+    var contentHandler: ((UNNotificationContent) -> Void)?
+    var receivedRequest: UNNotificationRequest!
+    var bestAttemptContent: UNMutableNotificationContent?
+
+    // Note this extension only runs when `mutable_content` is set
+    // Setting an attachment or action buttons automatically sets the property to true
+    override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
+        self.receivedRequest = request
+        self.contentHandler = contentHandler
+        self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
+
+        if let bestAttemptContent = bestAttemptContent {
+            // DEBUGGING: Uncomment the 2 lines below to check this extension is executing
+//            print("Running NotificationServiceExtension")
+//            bestAttemptContent.body = "[Modified] " + bestAttemptContent.body
+
+            OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest, with: bestAttemptContent, withContentHandler: self.contentHandler)
+        }
+    }
+
+    override func serviceExtensionTimeWillExpire() {
+        // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
+        if let contentHandler = contentHandler, let bestAttemptContent =  bestAttemptContent {
+            OneSignalExtension.serviceExtensionTimeWillExpireRequest(self.receivedRequest, with: self.bestAttemptContent)
+            contentHandler(bestAttemptContent)
+        }
+    }
+}

package/{build/support/serviceExtensionFiles → serviceExtensionFiles}/OneSignalNotificationServiceExtension-Info.plist

@@ -25,7 +25,7 @@
 		<key>NSExtensionPointIdentifier</key>
 		<string>com.apple.usernotifications.service</string>
 		<key>NSExtensionPrincipalClass</key>
-		<string>NotificationService</string>
+		<string>{{NSE_PRINCIPAL_CLASS}}</string>
 	</dict>
 </dict>
 </plist>

package/widgetExtensionFiles/OneSignalWidget-Info.plist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleDisplayName</key>
+	<string>OneSignalWidget</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>{{BUNDLE_SHORT_VERSION}}</string>
+	<key>CFBundleVersion</key>
+	<string>{{BUNDLE_VERSION}}</string>
+	<key>NSExtension</key>
+	<dict>
+		<key>NSExtensionPointIdentifier</key>
+		<string>com.apple.widgetkit-extension</string>
+	</dict>
+</dict>
+</plist>

package/widgetExtensionFiles/OneSignalWidgetBundle.swift

@@ -0,0 +1,9 @@
+import WidgetKit
+import SwiftUI
+
+@main
+struct OneSignalWidgetBundle: WidgetBundle {
+    var body: some Widget {
+        OneSignalWidgetLiveActivity()
+    }
+}

package/widgetExtensionFiles/OneSignalWidgetLiveActivity.swift

@@ -0,0 +1,58 @@
+// This default Live Activity widget uses OneSignal's `DefaultLiveActivityAttributes`
+// so you can drive it entirely from JS via `OneSignal.LiveActivities.setupDefault()`.
+// To use a custom attributes type, replace this file via the plugin's
+// `liveActivities.widgetFilePath` prop.
+//
+// See: https://documentation.onesignal.com/docs/cross-platform-live-activity-setup
+
+import ActivityKit
+import WidgetKit
+import SwiftUI
+import OneSignalLiveActivities
+
+struct OneSignalWidgetLiveActivity: Widget {
+    var body: some WidgetConfiguration {
+        ActivityConfiguration(for: DefaultLiveActivityAttributes.self) { context in
+            // Lock screen / banner UI
+            VStack {
+                Spacer()
+
+                Text("Title: " + (context.attributes.data["title"]?.asString() ?? ""))
+                    .font(.headline)
+
+                Spacer()
+
+                HStack {
+                    Spacer()
+                    Text(context.state.data["message"]?.asDict()?["en"]?.asString() ?? "Default Message")
+                    Spacer()
+                }
+
+                Spacer()
+            }
+            .activitySystemActionForegroundColor(.black)
+            .activityBackgroundTint(.white)
+
+        } dynamicIsland: { _ in
+            DynamicIsland {
+                DynamicIslandExpandedRegion(.leading) {
+                    Text("Leading")
+                }
+                DynamicIslandExpandedRegion(.trailing) {
+                    Text("Trailing")
+                }
+                DynamicIslandExpandedRegion(.bottom) {
+                    Text("Bottom")
+                }
+            } compactLeading: {
+                Text("L")
+            } compactTrailing: {
+                Text("T")
+            } minimal: {
+                Text("Min")
+            }
+            .widgetURL(URL(string: "http://www.apple.com"))
+            .keylineTint(Color.red)
+        }
+    }
+}

package/app.plugin.js

@@ -1 +0,0 @@
-module.exports = require('./build/onesignal/withOneSignal.js');

package/build/onesignal/withOneSignal.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/withOneSignal.js

@@ -1,20 +0,0 @@
-"use strict";
-/**
- * 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
- */
-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;
-};
-exports.default = withOneSignal;

package/build/onesignal/withOneSignalAndroid.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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

@@ -1,136 +0,0 @@
-"use strict";
-/**
- * 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-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/';
-// The name of each small icon folder resource, and the icon size for that folder.
-const SMALL_ICON_DIRS_TO_SIZE = {
-    'drawable-mdpi': 24,
-    'drawable-hdpi': 36,
-    'drawable-xhdpi': 48,
-    'drawable-xxhdpi': 72,
-    'drawable-xxxhdpi': 96,
-};
-// The name of each large icon folder resource, and the icon size for that folder.
-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;
-    }
-    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, SMALL_ICON_DEFAULT_NAME);
-            }
-            if (onesignalProps.smallIcons) {
-                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;
-    }
-    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, LARGE_ICON_DEFAULT_NAME);
-            }
-            return config;
-        },
-    ]);
-};
-const withSmallIconAccentColor = (config, onesignalProps) => {
-    if (!onesignalProps.smallIconAccentColor) {
-        return config;
-    }
-    return (0, config_plugins_1.withStringsXml)(config, (config) => {
-        const colorInARGB = (0, helpers_1.parseColorToARGB)(onesignalProps.smallIconAccentColor ?? '');
-        const strings = config.modResults.resources.string ?? [];
-        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;
-    });
-};
-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, 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);
-        if (!(0, fs_1.existsSync)(path)) {
-            (0, fs_1.mkdirSync)(path, { recursive: true });
-        }
-        const resizedIcon = (await (0, image_utils_1.generateImageAsync)({ projectRoot, cacheType: 'onesignal-icon' }, {
-            src: icon,
-            width: dirsToSize[iconResourceDir],
-            height: dirsToSize[iconResourceDir],
-            resizeMode: 'cover',
-            backgroundColor: 'transparent',
-        })).source;
-        (0, fs_1.writeFileSync)((0, path_1.resolve)(path, name + '.png'), resizedIcon);
-    }
-}
-const withSoundFiles = (config, onesignalProps) => {
-    if (!onesignalProps.sounds) {
-        return config;
-    }
-    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;
-        },
-    ]);
-};
-const withOneSignalAndroid = (config, props) => {
-    config = withSmallIcons(config, props);
-    config = withLargeIcons(config, props);
-    config = withSmallIconAccentColor(config, props);
-    config = withSoundFiles(config, props);
-    return config;
-};
-exports.withOneSignalAndroid = withOneSignalAndroid;

package/build/onesignal/withOneSignalIos.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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';
-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>;