@fishonfire/bubbles-expo 0.1.0

package/dist/register-task.mjs

@@ -0,0 +1,6 @@
+import {
+  registerBubblesBackgroundHandlers
+} from "./chunk-6NPXFGQX.mjs";
+
+// src/register-task.ts
+registerBubblesBackgroundHandlers();

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@fishonfire/bubbles-expo",
+  "version": "0.1.0",
+  "description": "Expo config plugin, explicit background registration API, and React provider for Bubbles notifications.",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./register-task": {
+      "types": "./dist/register-task.d.ts",
+      "import": "./dist/register-task.mjs",
+      "require": "./dist/register-task.js"
+    }
+  },
+  "files": [
+    "dist",
+    "plugin/build",
+    "app.plugin.js",
+    "README.md"
+  ],
+  "sideEffects": [
+    "./src/register-task.ts",
+    "./dist/register-task.js",
+    "./dist/register-task.mjs"
+  ],
+  "scripts": {
+    "build": "npm run build:runtime && npm run build:plugin",
+    "build:runtime": "tsup src/index.ts src/register-task.ts --format cjs,esm --dts --clean",
+    "build:plugin": "rm -rf plugin/build && tsc -p plugin/tsconfig.json",
+    "clean": "rm -rf dist plugin/build",
+    "lint": "expo lint src --no-cache --max-warnings 0",
+    "prepare": "npm run build",
+    "test": "vitest run",
+    "typecheck": "npm run typecheck:runtime && npm run typecheck:plugin && npm run typecheck:test",
+    "typecheck:test": "tsc -p tsconfig.test.json --noEmit",
+    "typecheck:runtime": "tsc --noEmit",
+    "typecheck:plugin": "tsc -p plugin/tsconfig.json --noEmit"
+  },
+  "keywords": [
+    "bubbles",
+    "expo",
+    "expo-notifications",
+    "config-plugin",
+    "react-native",
+    "background-task",
+    "push-notifications",
+    "fcm",
+    "apns"
+  ],
+  "peerDependencies": {
+    "@react-native-firebase/app": ">=26.3.3",
+    "@react-native-firebase/installations": ">=26.3.3",
+    "@react-native-firebase/messaging": ">=26.3.3",
+    "expo": ">=57.0.0",
+    "expo-notifications": ">=0.28.0",
+    "react": ">=19.0.0",
+    "react-native": ">=0.72.0"
+  },
+  "peerDependenciesMeta": {
+    "expo": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@fishonfire/bubbles-js": "0.1.0",
+    "expo-constants": "~57.0.16",
+    "expo-file-system": "~57.0.6"
+  },
+  "devDependencies": {
+    "@react-native-firebase/app": "^26.3.3",
+    "@react-native-firebase/installations": "^26.3.3",
+    "@react-native-firebase/messaging": "^26.3.3",
+    "@types/react": "^19.2.18",
+    "expo": "~57.0.11",
+    "expo-notifications": "~57.0.9",
+    "react": "^19.2.8",
+    "react-native": "^0.87.1",
+    "eslint": "^9.0.0",
+    "eslint-config-expo": "~57.0.1",
+    "tsup": "^8.2.4",
+    "tsx": "^4.19.2",
+    "typescript": "^5.5.4",
+    "vitest": "^3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/plugin/build/config.d.ts

@@ -0,0 +1,18 @@
+import { type AndroidChannelImportance } from './shared-config';
+export type BubblesNotificationsExpoPluginConfig = {
+    defaultChannelId?: string;
+    defaultChannelName?: string;
+    androidChannelImportance?: AndroidChannelImportance;
+    androidNotificationIcon?: string;
+    androidNotificationColor?: string;
+    enableBackgroundRemoteNotifications?: boolean;
+};
+export type NormalizedBubblesNotificationsExpoPluginConfig = {
+    defaultChannelId: string;
+    defaultChannelName: string;
+    androidChannelImportance: AndroidChannelImportance;
+    androidNotificationIcon?: string;
+    androidNotificationColor?: string;
+    enableBackgroundRemoteNotifications: boolean;
+};
+export declare function normalizePluginConfig(input?: BubblesNotificationsExpoPluginConfig | void): NormalizedBubblesNotificationsExpoPluginConfig;

package/plugin/build/config.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePluginConfig = normalizePluginConfig;
+const shared_config_1 = require("./shared-config");
+function fail(message) {
+    throw new Error(`[@fishonfire/bubbles-expo] ${message}`);
+}
+function assertPlainObjectOrUndefined(value) {
+    if (value === undefined) {
+        return;
+    }
+    if (value === null || typeof value !== 'object' || Array.isArray(value)) {
+        fail('Plugin options must be an object, for example ["@fishonfire/bubbles-expo", { "defaultChannelId": "default" }].');
+    }
+}
+function getOptionalNonEmptyString(value, propertyName) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (typeof value !== 'string') {
+        fail(`"${propertyName}" must be a string.`);
+    }
+    const trimmedValue = value.trim();
+    if (!trimmedValue) {
+        fail(`"${propertyName}" must not be empty.`);
+    }
+    return trimmedValue;
+}
+function getBooleanWithDefault(value, propertyName, fallback) {
+    if (value === undefined) {
+        return fallback;
+    }
+    if (typeof value !== 'boolean') {
+        fail(`"${propertyName}" must be a boolean.`);
+    }
+    return value;
+}
+function getAndroidChannelImportance(value) {
+    if (value === undefined) {
+        return 'max';
+    }
+    if (typeof value !== 'string' ||
+        !shared_config_1.ANDROID_CHANNEL_IMPORTANCE_VALUES.includes(value)) {
+        fail(`"androidChannelImportance" must be one of: ${shared_config_1.ANDROID_CHANNEL_IMPORTANCE_VALUES.join(', ')}.`);
+    }
+    return value;
+}
+function getOptionalNotificationColor(value) {
+    const color = getOptionalNonEmptyString(value, 'androidNotificationColor');
+    if (color === undefined) {
+        return undefined;
+    }
+    if (!/^#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/.test(color)) {
+        fail('"androidNotificationColor" must be a hex color in #RRGGBB or #AARRGGBB format.');
+    }
+    return color;
+}
+function normalizePluginConfig(input) {
+    assertPlainObjectOrUndefined(input);
+    const options = input ?? {};
+    return {
+        defaultChannelId: getOptionalNonEmptyString(options.defaultChannelId, 'defaultChannelId') ?? 'default',
+        defaultChannelName: getOptionalNonEmptyString(options.defaultChannelName, 'defaultChannelName') ?? 'Default',
+        androidChannelImportance: getAndroidChannelImportance(options.androidChannelImportance),
+        androidNotificationIcon: getOptionalNonEmptyString(options.androidNotificationIcon, 'androidNotificationIcon'),
+        androidNotificationColor: getOptionalNotificationColor(options.androidNotificationColor),
+        enableBackgroundRemoteNotifications: getBooleanWithDefault(options.enableBackgroundRemoteNotifications, 'enableBackgroundRemoteNotifications', true),
+    };
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+import { BubblesNotificationsExpoPluginConfig } from './config';
+declare const withBubblesNotificationsExpo: ConfigPlugin<BubblesNotificationsExpoPluginConfig | void>;
+export default withBubblesNotificationsExpo;

package/plugin/build/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("./config");
+const with_firebase_messaging_manifest_1 = __importDefault(require("./with-firebase-messaging-manifest"));
+const with_expo_notifications_1 = __importDefault(require("./with-expo-notifications"));
+const with_runtime_defaults_1 = __importDefault(require("./with-runtime-defaults"));
+const with_rnfirebase_disable_spm_1 = __importDefault(require("./with-rnfirebase-disable-spm"));
+const withBubblesNotificationsExpo = (config, input) => {
+    const options = (0, config_1.normalizePluginConfig)(input);
+    config = (0, with_runtime_defaults_1.default)(config, options);
+    config = (0, with_expo_notifications_1.default)(config, options);
+    config = (0, with_firebase_messaging_manifest_1.default)(config, options);
+    config = (0, with_rnfirebase_disable_spm_1.default)(config);
+    return config;
+};
+exports.default = withBubblesNotificationsExpo;

package/plugin/build/shared-config.d.ts

@@ -0,0 +1,3 @@
+export declare const BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY = "bubblesNotificationsExpo";
+export declare const ANDROID_CHANNEL_IMPORTANCE_VALUES: readonly ["min", "low", "default", "high", "max"];
+export type AndroidChannelImportance = (typeof ANDROID_CHANNEL_IMPORTANCE_VALUES)[number];

package/plugin/build/shared-config.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ANDROID_CHANNEL_IMPORTANCE_VALUES = exports.BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY = void 0;
+exports.BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY = 'bubblesNotificationsExpo';
+exports.ANDROID_CHANNEL_IMPORTANCE_VALUES = [
+    'min',
+    'low',
+    'default',
+    'high',
+    'max',
+];

package/plugin/build/with-expo-notifications.d.ts

@@ -0,0 +1,3 @@
+import type { ExpoConfig } from '@expo/config-types';
+import type { NormalizedBubblesNotificationsExpoPluginConfig } from './config';
+export default function withExpoNotifications(config: ExpoConfig, options: NormalizedBubblesNotificationsExpoPluginConfig): ExpoConfig;

package/plugin/build/with-expo-notifications.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = withExpoNotifications;
+const config_plugins_1 = require("expo/config-plugins");
+function withExpoNotifications(config, options) {
+    const pluginOptions = {
+        defaultChannel: options.defaultChannelId,
+        enableBackgroundRemoteNotifications: options.enableBackgroundRemoteNotifications,
+    };
+    if (options.androidNotificationIcon) {
+        pluginOptions.icon = options.androidNotificationIcon;
+    }
+    if (options.androidNotificationColor) {
+        pluginOptions.color = options.androidNotificationColor;
+    }
+    return (0, config_plugins_1.withStaticPlugin)(config, {
+        plugin: ['expo-notifications', pluginOptions],
+    });
+}

package/plugin/build/with-firebase-messaging-manifest.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+import type { NormalizedBubblesNotificationsExpoPluginConfig } from './config';
+declare const withFirebaseMessagingManifest: ConfigPlugin<NormalizedBubblesNotificationsExpoPluginConfig>;
+export default withFirebaseMessagingManifest;

package/plugin/build/with-firebase-messaging-manifest.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("expo/config-plugins");
+const FCM_DEFAULT_CHANNEL = 'com.google.firebase.messaging.default_notification_channel_id';
+const FCM_DEFAULT_COLOR = 'com.google.firebase.messaging.default_notification_color';
+const withFirebaseMessagingManifest = (config, options) => {
+    return (0, config_plugins_1.withAndroidManifest)(config, config => {
+        const manifest = config.modResults;
+        const application = config_plugins_1.AndroidConfig.Manifest.getMainApplicationOrThrow(manifest);
+        config_plugins_1.AndroidConfig.Manifest.ensureToolsAvailable(manifest);
+        // Always define the default channel ourselves.
+        //
+        // This makes the compatibility fix independent of whether
+        // expo-notifications' manifest mod runs before or after this one.
+        config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(application, FCM_DEFAULT_CHANNEL, options.defaultChannelId, 'value');
+        const channel = application['meta-data']?.find(item => item.$['android:name'] === FCM_DEFAULT_CHANNEL);
+        if (channel) {
+            setToolsReplace(channel.$, 'android:value');
+        }
+        // Expo only creates the FCM color metadata when a notification
+        // color has actually been configured.
+        if (options.androidNotificationColor) {
+            config_plugins_1.AndroidConfig.Manifest.addMetaDataItemToMainApplication(application, FCM_DEFAULT_COLOR, '@color/notification_icon_color', 'resource');
+            const color = application['meta-data']?.find(item => item.$['android:name'] === FCM_DEFAULT_COLOR);
+            if (color) {
+                setToolsReplace(color.$, 'android:resource');
+            }
+        }
+        return config;
+    });
+};
+function setToolsReplace(attributes, value) {
+    attributes['tools:replace'] = value;
+}
+exports.default = withFirebaseMessagingManifest;

package/plugin/build/with-rnfirebase-disable-spm.d.ts

@@ -0,0 +1,3 @@
+import { ConfigPlugin } from '@expo/config-plugins';
+declare const withRNFirebaseDisableSPM: ConfigPlugin;
+export default withRNFirebaseDisableSPM;

package/plugin/build/with-rnfirebase-disable-spm.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_plugins_1 = require("@expo/config-plugins");
+const withRNFirebaseDisableSPM = (config) => {
+    return (0, config_plugins_1.withPodfile)(config, (config) => {
+        const flag = '$RNFirebaseDisableSPM = true';
+        if (!config.modResults.contents.includes(flag)) {
+            config.modResults.contents =
+                `${flag}\n${config.modResults.contents}`;
+        }
+        return config;
+    });
+};
+exports.default = withRNFirebaseDisableSPM;

package/plugin/build/with-runtime-defaults.d.ts

@@ -0,0 +1,3 @@
+import type { ExpoConfig } from '@expo/config-types';
+import type { NormalizedBubblesNotificationsExpoPluginConfig } from './config';
+export default function withRuntimeDefaults(config: ExpoConfig, options: NormalizedBubblesNotificationsExpoPluginConfig): ExpoConfig;

package/plugin/build/with-runtime-defaults.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = withRuntimeDefaults;
+const shared_config_1 = require("./shared-config");
+function fail(message) {
+    throw new Error(`[@fishonfire/bubbles-expo] ${message}`);
+}
+function isPlainObject(value) {
+    return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+function withRuntimeDefaults(config, options) {
+    const existingExtra = config.extra ?? {};
+    const existingRuntimeDefaults = existingExtra[shared_config_1.BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY];
+    if (existingRuntimeDefaults !== undefined &&
+        !isPlainObject(existingRuntimeDefaults)) {
+        fail(`"expo.extra.${shared_config_1.BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY}" must be an object when it is defined.`);
+    }
+    const runtimeDefaults = {
+        defaultChannelId: options.defaultChannelId,
+        defaultChannelName: options.defaultChannelName,
+        androidChannelImportance: options.androidChannelImportance,
+    };
+    return {
+        ...config,
+        extra: {
+            ...existingExtra,
+            [shared_config_1.BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY]: {
+                ...(existingRuntimeDefaults ?? {}),
+                ...runtimeDefaults,
+            },
+        },
+    };
+}