expo-privacy-image 1.0.0

package/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  root: true,
+  extends: ['universe/native', 'universe/web'],
+  ignorePatterns: ['build'],
+};

package/README.md

@@ -0,0 +1,139 @@
+# expo-privacy-image
+
+A React Native module that overlays a privacy image on the screen whenever the app goes to the background — preventing sensitive content from appearing in the app switcher (iOS) or recent apps (Android).
+
+Built with [Expo Modules](https://docs.expo.dev/modules/overview/).
+
+---
+
+## Platform support
+
+| Android | iOS |
+| ------- | --- |
+| ✅      | ✅  |
+
+---
+
+## Installation
+
+```sh
+npm install expo-privacy-image
+```
+
+or
+
+```sh
+yarn add expo-privacy-image
+```
+
+---
+
+## Setup
+
+### Expo managed / bare workflow (with `expo prebuild`)
+
+Add the plugin to your `app.config.ts` (or `app.json`) and point it at your privacy image:
+
+```ts
+// app.config.ts
+export default {
+  plugins: [
+    [
+      "expo-privacy-image",
+      {
+        imagePath: "./assets/images/privacy.png",
+      },
+    ],
+  ],
+};
+```
+
+Then run prebuild to apply the native changes:
+
+```sh
+npx expo prebuild
+```
+
+The plugin automatically:
+- **Android** — copies the image to `android/app/src/main/res/drawable/privacy_image.png`
+- **iOS** — adds the image as `PrivacyImage.imageset` inside `Images.xcassets`
+
+### Bare React Native (manual setup)
+
+Ensure [`expo-modules-core`](https://docs.expo.dev/bare/installing-expo-modules/) is installed before proceeding — it is required for autolinking to work.
+
+**Android**
+
+Copy your privacy image to:
+
+```
+android/app/src/main/res/drawable/privacy_image.png
+```
+
+**iOS**
+
+Create the imageset directory and add your image:
+
+```
+ios/<ProjectName>/Images.xcassets/PrivacyImage.imageset/
+  privacy_image.png
+  Contents.json
+```
+
+`Contents.json` should contain:
+
+```json
+{
+  "images": [
+    { "idiom": "universal", "filename": "privacy_image.png", "scale": "1x" }
+  ],
+  "info": { "version": 1, "author": "xcode" }
+}
+```
+
+Then run:
+
+```sh
+npx pod-install
+```
+
+---
+
+## Usage
+
+Call `usePrivacyImage()` once — typically at the root of your app or inside a top-level component. Once called, the module is permanently enabled for the lifetime of the app session.
+
+```ts
+import { usePrivacyImage } from "expo-privacy-image";
+
+export default function App() {
+  usePrivacyImage();
+
+  return (
+    // ...
+  );
+}
+```
+
+When the app moves to the background, the image you configured is shown as a full-screen overlay. It is removed automatically when the app returns to the foreground.
+
+---
+
+## API
+
+### `usePrivacyImage(): void`
+
+Enables the privacy overlay for the current app session. Safe to call multiple times — subsequent calls are no-ops.
+
+| Parameter | Type | Description |
+| --------- | ---- | ----------- |
+| —         | —    | No parameters |
+
+---
+
+## Requirements
+
+- React Native ≥ 0.71
+- expo
+- iOS ≥ 15.1
+

package/android/build.gradle

@@ -0,0 +1,18 @@
+plugins {
+  id 'com.android.library'
+  id 'expo-module-gradle-plugin'
+}
+
+group = 'expo.modules.privacyimage'
+version = '0.1.0'
+
+android {
+  namespace "expo.modules.privacyimage"
+  defaultConfig {
+    versionCode 1
+    versionName "0.1.0"
+  }
+  lintOptions {
+    abortOnError false
+  }
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest>
+</manifest>

package/android/src/main/java/expo/modules/privacyimage/PrivacyImageModule.kt

@@ -0,0 +1,83 @@
+package expo.modules.privacyimage
+
+import android.view.ViewGroup
+import android.widget.ImageView
+import expo.modules.kotlin.exception.Exceptions
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+class PrivacyImageModule : Module() {
+
+  private var isPrivacyEnabled: Boolean = false
+  // Each module class must implement the definition function. The definition consists of components
+  // that describes the module's functionality and behavior.
+  // See https://docs.expo.dev/modules/module-api for more details about available components.
+  private val safeCurrentActivity
+    get() = appContext.currentActivity
+  private val currentActivity
+    get() = safeCurrentActivity ?: throw Exceptions.MissingActivity()
+
+  private var overlayView: ImageView? = null
+
+  private fun showOverlay() {
+    currentActivity.runOnUiThread {
+      if (overlayView != null) return@runOnUiThread
+
+      val overlay =
+              ImageView(currentActivity).apply {
+                val drawableId =
+                        currentActivity.resources.getIdentifier(
+                                "privacy_image",
+                                "drawable",
+                                currentActivity.packageName
+                        )
+                setImageResource(drawableId)
+                scaleType = ImageView.ScaleType.CENTER_CROP
+                layoutParams =
+                        ViewGroup.LayoutParams(
+                                ViewGroup.LayoutParams.MATCH_PARENT,
+                                ViewGroup.LayoutParams.MATCH_PARENT
+                        )
+              }
+
+      val rootView = currentActivity.window.decorView as ViewGroup
+      rootView.addView(overlay)
+      overlayView = overlay
+    }
+  }
+
+  private fun hideOverlay() {
+    currentActivity.runOnUiThread {
+      val rootView = currentActivity.window.decorView as ViewGroup
+      overlayView?.let {
+        rootView.removeView(it)
+        overlayView = null
+      }
+    }
+  }
+
+  override fun definition() = ModuleDefinition {
+    // Sets the name of the module that JavaScript code will use to refer to the module. Takes a
+    // string as an argument.
+    // Can be inferred from module's class name, but it's recommended to set it explicitly for
+    // clarity.
+    // The module will be accessible from `requireNativeModule('PrivacyImage')` in JavaScript.
+    Name("PrivacyImage")
+
+    Function("usePrivacyImage") { isPrivacyEnabled = true }
+
+    OnActivityEntersBackground {
+      // Show privacy overlay
+      if (!isPrivacyEnabled) return@OnActivityEntersBackground
+
+      showOverlay()
+    }
+
+    OnActivityEntersForeground {
+      // Remove privacy overlay
+      if (!isPrivacyEnabled) return@OnActivityEntersForeground
+
+      hideOverlay()
+    }
+  }
+}

package/build/PrivacyImageModule.d.ts

@@ -0,0 +1,7 @@
+import { NativeModule } from "expo";
+declare class PrivacyImageModule extends NativeModule {
+    usePrivacyImage: () => void;
+}
+declare const _default: PrivacyImageModule;
+export default _default;
+//# sourceMappingURL=PrivacyImageModule.d.ts.map

package/build/PrivacyImageModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivacyImageModule.d.ts","sourceRoot":"","sources":["../src/PrivacyImageModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAuB,MAAM,MAAM,CAAC;AAEzD,OAAO,OAAO,kBAAmB,SAAQ,YAAY;IACnD,eAAe,EAAE,MAAM,IAAI,CAAC;CAC7B;;AAGD,wBAAuE"}

package/build/PrivacyImageModule.js

@@ -0,0 +1,4 @@
+import { requireNativeModule } from "expo";
+// This call loads the native module object from the JSI.
+export default requireNativeModule("PrivacyImage");
+//# sourceMappingURL=PrivacyImageModule.js.map

package/build/PrivacyImageModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivacyImageModule.js","sourceRoot":"","sources":["../src/PrivacyImageModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAMzD,yDAAyD;AACzD,eAAe,mBAAmB,CAAqB,cAAc,CAAC,CAAC","sourcesContent":["import { NativeModule, requireNativeModule } from \"expo\";\n\ndeclare class PrivacyImageModule extends NativeModule {\n  usePrivacyImage: () => void;\n}\n\n// This call loads the native module object from the JSI.\nexport default requireNativeModule<PrivacyImageModule>(\"PrivacyImage\");\n"]}

package/build/index.d.ts

@@ -0,0 +1,2 @@
+export declare function usePrivacyImage(): void;
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe,SAE9B"}

package/build/index.js

@@ -0,0 +1,5 @@
+import PrivacyImageModule from "./PrivacyImageModule";
+export function usePrivacyImage() {
+    PrivacyImageModule.usePrivacyImage();
+}
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAEtD,MAAM,UAAU,eAAe;IAC7B,kBAAkB,CAAC,eAAe,EAAE,CAAC;AACvC,CAAC","sourcesContent":["import PrivacyImageModule from \"./PrivacyImageModule\";\n\nexport function usePrivacyImage() {\n  PrivacyImageModule.usePrivacyImage();\n}\n"]}

package/expo-module.config.json

@@ -0,0 +1,10 @@
+{
+  "platforms": ["apple", "android"],
+  "apple": {
+    "modules": ["PrivacyImageModule"],
+    "appDelegateSubscribers": ["AppLifecycleDelegate"]
+  },
+  "android": {
+    "modules": ["expo.modules.privacyimage.PrivacyImageModule"]
+  }
+}

package/ios/AppLifecycleDelegate.swift

@@ -0,0 +1,46 @@
+import ExpoModulesCore
+
+public class AppLifecycleDelegate: ExpoAppDelegateSubscriber {
+
+    private var overlayView: UIImageView?
+
+    public func applicationWillResignActive(_ application: UIApplication) {
+        guard PrivacyImageModule.isPrivacyEnabled else { return }
+        self.showOverlay()
+    }
+
+    public func applicationDidBecomeActive(_ application: UIApplication) {
+        guard PrivacyImageModule.isPrivacyEnabled else { return }
+        self.hideOverlay()
+    }
+
+    private func showOverlay() {
+        DispatchQueue.main.async {
+            guard self.overlayView == nil,
+                let window = self.getKeyWindow()
+            else { return }
+
+            let overlay = UIImageView(frame: window.bounds)
+            overlay.image = UIImage(named: "PrivacyImage")
+            overlay.contentMode = .scaleAspectFill
+            overlay.tag = 999
+
+            window.addSubview(overlay)
+            self.overlayView = overlay
+        }
+    }
+
+    private func hideOverlay() {
+        DispatchQueue.main.async {
+            self.overlayView?.removeFromSuperview()
+            self.overlayView = nil
+        }
+    }
+
+    private func getKeyWindow() -> UIWindow? {
+        UIApplication.shared.connectedScenes
+            .compactMap { $0 as? UIWindowScene }
+            .flatMap { $0.windows }
+            .first { $0.isKeyWindow }
+    }
+}

package/ios/PrivacyImage.podspec

@@ -0,0 +1,28 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name           = 'PrivacyImage'
+  s.version        = package['version']
+  s.summary        = package['description']
+  s.description    = package['description']
+  s.license        = package['license']
+  s.author         = package['author']
+  s.homepage       = package['homepage']
+  s.platforms      = {
+    :ios => '15.1',
+  }
+  s.swift_version  = '5.9'
+  s.source         = { git: 'https://github.com/ntphu1808/expo-privacy-image' }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES',
+  }
+
+  s.source_files = "**/*.{h,m,mm,swift,hpp,cpp}"
+end

package/ios/PrivacyImageModule.swift

@@ -0,0 +1,20 @@
+import ExpoModulesCore
+
+public class PrivacyImageModule: Module {
+  // Each module class must implement the definition function. The definition consists of components
+  // that describes the module's functionality and behavior.
+  // See https://docs.expo.dev/modules/module-api for more details about available components.
+
+  static var isPrivacyEnabled: Bool = false
+
+  public func definition() -> ModuleDefinition {
+    // Sets the name of the module that JavaScript code will use to refer to the module. Takes a string as an argument.
+    // Can be inferred from module's class name, but it's recommended to set it explicitly for clarity.
+    // The module will be accessible from `requireNativeModule('PrivacyImage')` in JavaScript.
+    Name("PrivacyImage")
+
+    Function("usePrivacyImage") {
+      PrivacyImageModule.isPrivacyEnabled = true
+    }
+  }
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "expo-privacy-image",
+  "version": "1.0.0",
+  "description": "Overlays a privacy image on the screen when the app goes to the background.",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "expo-module build",
+    "clean": "expo-module clean",
+    "lint": "expo-module lint",
+    "test": "expo-module test",
+    "prepare": "expo-module prepare",
+    "prepublishOnly": "expo-module prepublishOnly",
+    "expo-module": "expo-module"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "expo-privacy-image",
+    "PrivacyImage"
+  ],
+  "repository": "https://github.com/ntphu1808/expo-privacy-image",
+  "bugs": {
+    "url": "https://github.com/ntphu1808/expo-privacy-image/issues"
+  },
+  "author": "Nguyen Tran Phu <ntphu081995@gmail.com> (https://github.com/ntphu1808)",
+  "license": "MIT",
+  "homepage": "https://github.com/ntphu1808/expo-privacy-image#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "@types/react": "~19.1.1",
+    "expo-module-scripts": "^55.0.2",
+    "expo": "^55.0.14",
+    "react-native": "0.82.1"
+  },
+  "peerDependencies": {
+    "expo": "*",
+    "react": "*",
+    "react-native": "*"
+  }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,6 @@
+import { ConfigPlugin } from "expo/config-plugins";
+type PrivacyImageProps = {
+    imagePath: string;
+};
+declare const withPrivacyImage: ConfigPlugin<PrivacyImageProps>;
+export default withPrivacyImage;

package/plugin/build/index.js

@@ -0,0 +1,71 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+// plugins/withPrivacyImage.ts
+const config_plugins_1 = require("expo/config-plugins");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const withPrivacyImage = (config, { imagePath }) => {
+    // Android - copy to res/drawable
+    config = (0, config_plugins_1.withDangerousMod)(config, [
+        "android",
+        async (config) => {
+            const src = path.resolve(config.modRequest.projectRoot, imagePath);
+            const dest = path.join(config.modRequest.platformProjectRoot, "app/src/main/res/drawable/privacy_image.png");
+            fs.mkdirSync(path.dirname(dest), { recursive: true });
+            fs.copyFileSync(src, dest);
+            return config;
+        },
+    ]);
+    // iOS - copy into Images.xcassets as an imageset so UIImage(named:) works
+    config = (0, config_plugins_1.withDangerousMod)(config, [
+        "ios",
+        async (config) => {
+            const src = path.resolve(config.modRequest.projectRoot, imagePath);
+            const projectName = config.modRequest.projectName;
+            const imagesetDir = path.join(config.modRequest.platformProjectRoot, projectName, "Images.xcassets", "PrivacyImage.imageset");
+            fs.mkdirSync(imagesetDir, { recursive: true });
+            fs.copyFileSync(src, path.join(imagesetDir, "privacy_image.png"));
+            const contents = {
+                images: [{ idiom: "universal", filename: "privacy_image.png", scale: "1x" }],
+                info: { version: 1, author: "xcode" },
+            };
+            fs.writeFileSync(path.join(imagesetDir, "Contents.json"), JSON.stringify(contents, null, 2));
+            return config;
+        },
+    ]);
+    return config;
+};
+exports.default = withPrivacyImage;

package/plugin/src/index.ts

@@ -0,0 +1,49 @@
+// plugins/withPrivacyImage.ts
+import { ConfigPlugin, withDangerousMod } from "expo/config-plugins";
+import * as fs from "fs";
+import * as path from "path";
+
+type PrivacyImageProps = {
+  imagePath: string;
+};
+
+const withPrivacyImage: ConfigPlugin<PrivacyImageProps> = (config, { imagePath }) => {
+  // Android - copy to res/drawable
+  config = withDangerousMod(config, [
+    "android",
+    async (config) => {
+      const src = path.resolve(config.modRequest.projectRoot, imagePath);
+      const dest = path.join(config.modRequest.platformProjectRoot, "app/src/main/res/drawable/privacy_image.png");
+      fs.mkdirSync(path.dirname(dest), { recursive: true });
+      fs.copyFileSync(src, dest);
+      return config;
+    },
+  ]);
+
+  // iOS - copy into Images.xcassets as an imageset so UIImage(named:) works
+  config = withDangerousMod(config, [
+    "ios",
+    async (config) => {
+      const src = path.resolve(config.modRequest.projectRoot, imagePath);
+      const projectName = config.modRequest.projectName!;
+      const imagesetDir = path.join(
+        config.modRequest.platformProjectRoot,
+        projectName,
+        "Images.xcassets",
+        "PrivacyImage.imageset",
+      );
+      fs.mkdirSync(imagesetDir, { recursive: true });
+      fs.copyFileSync(src, path.join(imagesetDir, "privacy_image.png"));
+      const contents = {
+        images: [{ idiom: "universal", filename: "privacy_image.png", scale: "1x" }],
+        info: { version: 1, author: "xcode" },
+      };
+      fs.writeFileSync(path.join(imagesetDir, "Contents.json"), JSON.stringify(contents, null, 2));
+      return config;
+    },
+  ]);
+
+  return config;
+};
+
+export default withPrivacyImage;

package/plugin/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "expo-module-scripts/tsconfig.plugin",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src"
+  },
+  "include": ["src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}

package/plugin/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/index.ts"],"version":"5.9.3"}

package/src/PrivacyImageModule.ts

@@ -0,0 +1,8 @@
+import { NativeModule, requireNativeModule } from "expo";
+
+declare class PrivacyImageModule extends NativeModule {
+  usePrivacyImage: () => void;
+}
+
+// This call loads the native module object from the JSI.
+export default requireNativeModule<PrivacyImageModule>("PrivacyImage");

package/src/index.ts

@@ -0,0 +1,5 @@
+import PrivacyImageModule from "./PrivacyImageModule";
+
+export function usePrivacyImage() {
+  PrivacyImageModule.usePrivacyImage();
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+// @generated by expo-module-scripts
+{
+  "extends": "expo-module-scripts/tsconfig.base",
+  "compilerOptions": {
+    "outDir": "./build"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__rsc_tests__/*"]
+}