react-native-privacy-guard-kit 0.1.0

package/src/Hooks.ts

@@ -0,0 +1,138 @@
+import { useState, useEffect, useCallback } from 'react';
+import {
+  disableScreenCapture,
+  enableScreenCapture,
+  isScreenBeingRecorded,
+  enableAppSwitcherProtection,
+  disableAppSwitcherProtection,
+  clearClipboard,
+  onScreenshotTaken,
+  onScreenRecordingStarted,
+  onScreenRecordingStopped,
+} from './PrivacyGuardkitApi';
+import type { UsePrivacyGuardReturn, PrivacyGuardKitConfig } from './types';
+
+// ─────────────────────────────────────────────────────────────
+// usePrivacyGuard
+// ─────────────────────────────────────────────────────────────
+
+/**
+ * One-stop hook that wires up all privacy guard features declaratively.
+ *
+ * @example
+ * const { isRecording, disableScreenCapture } = usePrivacyGuard({
+ *   disableScreenCapture: true,
+ *   enableAppSwitcherProtection: true,
+ * });
+ */
+export function usePrivacyGuard(
+  config: PrivacyGuardKitConfig = {}
+): UsePrivacyGuardReturn {
+  const [captureDisabled, setCaptureDisabled] = useState(false);
+  const [isRecording, setIsRecording] = useState(false);
+
+  // Apply config on mount
+  useEffect(() => {
+    if (config.disableScreenCapture) {
+      disableScreenCapture().then(() => setCaptureDisabled(true));
+    }
+    if (config.enableAppSwitcherProtection) {
+      enableAppSwitcherProtection();
+    }
+
+    // Bootstrap recording state
+    isScreenBeingRecorded().then(setIsRecording);
+
+    // Recording listeners
+    const stopStart = onScreenRecordingStarted(() => setIsRecording(true));
+    const stopStop = onScreenRecordingStopped(() => setIsRecording(false));
+
+    return () => {
+      if (config.disableScreenCapture) {
+        enableScreenCapture().then(() => setCaptureDisabled(false));
+      }
+      if (config.enableAppSwitcherProtection) {
+        disableAppSwitcherProtection();
+      }
+      stopStart();
+      stopStop();
+    };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  const handleDisableCapture = useCallback(async () => {
+    await disableScreenCapture();
+    setCaptureDisabled(true);
+  }, []);
+
+  const handleEnableCapture = useCallback(async () => {
+    await enableScreenCapture();
+    setCaptureDisabled(false);
+  }, []);
+
+  return {
+    isScreenCaptureDisabled: captureDisabled,
+    isRecording,
+    disableScreenCapture: handleDisableCapture,
+    enableScreenCapture: handleEnableCapture,
+    enableAppSwitcherProtection: async () => {
+      await enableAppSwitcherProtection();
+    },
+    disableAppSwitcherProtection: async () => {
+      await disableAppSwitcherProtection();
+    },
+    clearClipboard,
+  };
+}
+
+// ─────────────────────────────────────────────────────────────
+// useScreenshotListener
+// ─────────────────────────────────────────────────────────────
+
+/**
+ * Calls `onTaken` every time the user takes a screenshot.
+ *
+ * @example
+ * useScreenshotListener(() => {
+ *   console.log('Screenshot detected!');
+ * });
+ */
+export function useScreenshotListener(onTaken: () => void): void {
+  useEffect(() => {
+    const remove = onScreenshotTaken(onTaken);
+    return remove;
+  }, [onTaken]);
+}
+
+// ─────────────────────────────────────────────────────────────
+// useScreenRecording
+// ─────────────────────────────────────────────────────────────
+
+/**
+ * Reactive boolean — true while screen is being recorded.
+ *
+ * @example
+ * const isRecording = useScreenRecording();
+ * if (isRecording) return <BlurredScreen />;
+ */
+export function useScreenRecording(): boolean {
+  const [isRecording, setIsRecording] = useState(false);
+
+  useEffect(() => {
+    isScreenBeingRecorded().then(setIsRecording);
+
+    const stopStart = onScreenRecordingStarted(({ isRecording: r }) =>
+      setIsRecording(r)
+    );
+    const stopEnd = onScreenRecordingStopped(({ isRecording: r }) =>
+      setIsRecording(r)
+    );
+
+    return () => {
+      stopStart();
+      stopEnd();
+    };
+  }, []);
+
+  return isRecording;
+}

package/src/NativePrivacyGuardKit.ts

@@ -0,0 +1,13 @@
+import { NativeModules, NativeEventEmitter } from 'react-native';
+
+const { PrivacyGuardKit } = NativeModules;
+
+if (!PrivacyGuardKit) {
+  throw new Error(
+    '[react-native-privacy-guard-kit] Native module not found. ' +
+      'Make sure you have linked the library and rebuilt the app.'
+  );
+}
+
+export const NativePrivacyGuardKit = PrivacyGuardKit;
+export const PrivacyGuardKitEmitter = new NativeEventEmitter(PrivacyGuardKit);

package/src/PrivacyGuardProvider.tsx

@@ -0,0 +1,134 @@
+import {
+  createContext,
+  useContext,
+  useEffect,
+  useState,
+  useCallback,
+  type ReactNode,
+} from 'react';
+import {
+  disableScreenCapture,
+  enableScreenCapture,
+  enableAppSwitcherProtection,
+  disableAppSwitcherProtection,
+  isScreenBeingRecorded,
+  clearClipboard,
+  onScreenRecordingStarted,
+  onScreenRecordingStopped,
+  onScreenshotTaken,
+} from './PrivacyGuardkitApi';
+import type { PrivacyGuardKitConfig, UsePrivacyGuardReturn } from './types';
+
+// ─────────────────────────────────────────────────────────────
+// Context
+// ─────────────────────────────────────────────────────────────
+
+type PrivacyGuardContextType = UsePrivacyGuardReturn | null;
+const PrivacyGuardContext = createContext<PrivacyGuardContextType>(null);
+
+// ─────────────────────────────────────────────────────────────
+// Provider
+// ─────────────────────────────────────────────────────────────
+
+interface PrivacyGuardProviderProps {
+  children: ReactNode;
+  config?: PrivacyGuardKitConfig;
+  /** Called every time a screenshot is detected */
+  onScreenshot?: () => void;
+}
+
+/**
+ * Wrap your root (or any sensitive screen) with this provider.
+ * All children can call `usePrivacyGuardContext()` to access the API.
+ *
+ * @example
+ * <PrivacyGuardProvider
+ *   config={{ disableScreenCapture: true, enableAppSwitcherProtection: true }}
+ *   onScreenshot={() => Alert.alert('Screenshot blocked!')}
+ * >
+ *   <App />
+ * </PrivacyGuardProvider>
+ */
+export function PrivacyGuardProvider({
+  children,
+  config = {},
+  onScreenshot,
+}: PrivacyGuardProviderProps) {
+  const [captureDisabled, setCaptureDisabled] = useState(false);
+  const [isRecording, setIsRecording] = useState(false);
+
+  useEffect(() => {
+    // Apply config
+    if (config.disableScreenCapture) {
+      disableScreenCapture().then(() => setCaptureDisabled(true));
+    }
+    if (config.enableAppSwitcherProtection) {
+      enableAppSwitcherProtection();
+    }
+
+    isScreenBeingRecorded().then(setIsRecording);
+
+    // Event subscriptions
+    const cleanups: Array<() => void> = [];
+
+    if (onScreenshot) {
+      cleanups.push(onScreenshotTaken(onScreenshot));
+    }
+
+    cleanups.push(onScreenRecordingStarted(() => setIsRecording(true)));
+    cleanups.push(onScreenRecordingStopped(() => setIsRecording(false)));
+
+    return () => {
+      cleanups.forEach((fn) => fn());
+      if (config.disableScreenCapture) enableScreenCapture();
+      if (config.enableAppSwitcherProtection) disableAppSwitcherProtection();
+    };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  const handleDisable = useCallback(async () => {
+    await disableScreenCapture();
+    setCaptureDisabled(true);
+  }, []);
+
+  const handleEnable = useCallback(async () => {
+    await enableScreenCapture();
+    setCaptureDisabled(false);
+  }, []);
+
+  const value: UsePrivacyGuardReturn = {
+    isScreenCaptureDisabled: captureDisabled,
+    isRecording,
+    disableScreenCapture: handleDisable,
+    enableScreenCapture: handleEnable,
+    enableAppSwitcherProtection: async () => enableAppSwitcherProtection(),
+    disableAppSwitcherProtection: async () => disableAppSwitcherProtection(),
+    clearClipboard,
+  };
+
+  return (
+    <PrivacyGuardContext.Provider value={value}>
+      {children}
+    </PrivacyGuardContext.Provider>
+  );
+}
+
+// ─────────────────────────────────────────────────────────────
+// Consumer hook
+// ─────────────────────────────────────────────────────────────
+
+/**
+ * Access the PrivacyGuard API from any component inside the provider.
+ *
+ * @example
+ * const { isRecording } = usePrivacyGuardContext();
+ */
+export function usePrivacyGuardContext(): UsePrivacyGuardReturn {
+  const ctx = useContext<PrivacyGuardContextType>(PrivacyGuardContext);
+  if (!ctx) {
+    throw new Error(
+      'usePrivacyGuardContext must be used inside <PrivacyGuardProvider>'
+    );
+  }
+  return ctx;
+}

package/src/PrivacyGuardkitApi.ts

@@ -0,0 +1,123 @@
+import {
+  NativePrivacyGuardKit,
+  PrivacyGuardKitEmitter,
+} from './NativePrivacyGuardKit';
+import type { ScreenRecordingEventPayload } from './types';
+
+// ─────────────────────────────────────────────────────────────
+// Screen Capture
+// ─────────────────────────────────────────────────────────────
+
+/**
+ * Prevents screenshots and blurs screen-recording output.
+ * On Android uses FLAG_SECURE; on iOS uses a secure UITextField overlay.
+ */
+export async function disableScreenCapture(): Promise<void> {
+  await NativePrivacyGuardKit.disableScreenCapture();
+}
+
+/** Re-enables screenshots and screen-recording. */
+export async function enableScreenCapture(): Promise<void> {
+  await NativePrivacyGuardKit.enableScreenCapture();
+}
+
+/** Returns true if screen capture is currently disabled. */
+export async function isScreenCaptureDisabled(): Promise<boolean> {
+  return NativePrivacyGuardKit.isScreenCaptureDisabled();
+}
+
+// ─────────────────────────────────────────────────────────────
+// Screen Recording Detection
+// ─────────────────────────────────────────────────────────────
+
+/** Returns true if the screen is currently being recorded/mirrored. */
+export async function isScreenBeingRecorded(): Promise<boolean> {
+  return NativePrivacyGuardKit.isScreenBeingRecorded();
+}
+
+// ─────────────────────────────────────────────────────────────
+// App Switcher Protection
+// ─────────────────────────────────────────────────────────────
+
+/**
+ * Covers the app preview shown in the OS task switcher with a
+ * blank overlay, preventing sensitive content from being visible.
+ */
+export async function enableAppSwitcherProtection(): Promise<void> {
+  await NativePrivacyGuardKit.enableAppSwitcherProtection();
+}
+
+/** Removes the app switcher overlay. */
+export async function disableAppSwitcherProtection(): Promise<void> {
+  await NativePrivacyGuardKit.disableAppSwitcherProtection();
+}
+
+// ─────────────────────────────────────────────────────────────
+// Clipboard
+// ─────────────────────────────────────────────────────────────
+
+/** Clears the system clipboard immediately. */
+export async function clearClipboard(): Promise<void> {
+  await NativePrivacyGuardKit.clearClipboard();
+}
+
+// ─────────────────────────────────────────────────────────────
+// Event Listeners
+// ─────────────────────────────────────────────────────────────
+
+type ScreenshotListener = () => void;
+type RecordingListener = (payload: ScreenRecordingEventPayload) => void;
+
+// NativeEventEmitter expects (...args: readonly Object[]) => unknown
+// We wrap the typed callback to satisfy that constraint safely.
+type NativeListener = (...args: readonly object[]) => unknown;
+
+/**
+ * Starts the native screenshot observer and registers your callback.
+ * Returns a cleanup function — call it to unsubscribe.
+ *
+ * @example
+ * const remove = onScreenshotTaken(() => Alert.alert('Screenshot detected!'));
+ * // later:
+ * remove();
+ */
+export function onScreenshotTaken(callback: ScreenshotListener): () => void {
+  NativePrivacyGuardKit.startScreenshotListener();
+  const sub = PrivacyGuardKitEmitter.addListener(
+    'onScreenshotTaken',
+    callback as NativeListener
+  );
+  return () => {
+    sub.remove();
+    NativePrivacyGuardKit.stopScreenshotListener();
+  };
+}
+
+/**
+ * Fires when screen recording begins.
+ * Returns a cleanup function.
+ */
+export function onScreenRecordingStarted(
+  callback: RecordingListener
+): () => void {
+  NativePrivacyGuardKit.startScreenshotListener(); // same listener start
+  const sub = PrivacyGuardKitEmitter.addListener(
+    'onScreenRecordingStarted',
+    callback as NativeListener
+  );
+  return () => sub.remove();
+}
+
+/**
+ * Fires when screen recording stops.
+ * Returns a cleanup function.
+ */
+export function onScreenRecordingStopped(
+  callback: RecordingListener
+): () => void {
+  const sub = PrivacyGuardKitEmitter.addListener(
+    'onScreenRecordingStopped',
+    callback as NativeListener
+  );
+  return () => sub.remove();
+}

package/src/SecureView.tsx

@@ -0,0 +1,29 @@
+// SecureView.tsx
+import { type ReactNode } from 'react';
+import { StyleSheet, type ViewStyle, type StyleProp } from 'react-native';
+import RNSecureViewSpec from './specs/RNSecureViewNativeComponent';
+
+type SecureViewProps = {
+  disableCopyPaste?: boolean;
+  style?: StyleProp<ViewStyle>;
+  children?: ReactNode;
+};
+
+export function SecureView({
+  disableCopyPaste = true,
+  style,
+  children,
+}: SecureViewProps) {
+  return (
+    <RNSecureViewSpec
+      isCopyPasteDisabled={disableCopyPaste}
+      style={[styles.container, style]}
+    >
+      {children}
+    </RNSecureViewSpec>
+  );
+}
+
+const styles = StyleSheet.create({
+  container: { flex: 1 },
+});

package/src/index.tsx

@@ -0,0 +1,37 @@
+// API
+export {
+  disableScreenCapture,
+  enableScreenCapture,
+  isScreenCaptureDisabled,
+  isScreenBeingRecorded,
+  enableAppSwitcherProtection,
+  disableAppSwitcherProtection,
+  clearClipboard,
+  onScreenshotTaken,
+  onScreenRecordingStarted,
+  onScreenRecordingStopped,
+} from './PrivacyGuardkitApi';
+
+// Hooks
+export {
+  usePrivacyGuard,
+  useScreenshotListener,
+  useScreenRecording,
+} from './Hooks';
+
+// Provider + context hook
+export {
+  PrivacyGuardProvider,
+  usePrivacyGuardContext,
+} from './PrivacyGuardProvider';
+
+// Components
+export { SecureView } from './SecureView';
+
+// Types
+export type {
+  PrivacyGuardEvent,
+  PrivacyGuardKitConfig,
+  UsePrivacyGuardReturn,
+  ScreenRecordingEventPayload,
+} from './types';

package/src/specs/RNSecureViewNativeComponent.ts

@@ -0,0 +1,19 @@
+/**
+ * @format
+ */
+
+// RN 0.73+ exports codegenNativeComponent from the top-level package.
+// Deep imports like 'react-native/Libraries/Utilities/codegenNativeComponent'
+// are deprecated and broken in RN 0.83. Use the top-level export instead.
+
+import type { ViewProps } from 'react-native';
+import { codegenNativeComponent } from 'react-native';
+import type { HostComponent } from 'react-native';
+
+export interface NativeProps extends ViewProps {
+  isCopyPasteDisabled?: boolean;
+}
+
+export default codegenNativeComponent<NativeProps>(
+  'RNSecureView'
+) as HostComponent<NativeProps>;

package/src/types.ts

@@ -0,0 +1,34 @@
+export type PrivacyGuardEvent =
+  | 'onScreenshotTaken'
+  | 'onScreenRecordingStarted'
+  | 'onScreenRecordingStopped';
+
+export interface ScreenRecordingEventPayload {
+  isRecording: boolean;
+}
+
+export interface PrivacyGuardKitConfig {
+  /** Disable screen capture (screenshot + screen recording blur) */
+  disableScreenCapture?: boolean;
+  /** Show a blank overlay in the app switcher */
+  enableAppSwitcherProtection?: boolean;
+  /** Prevent copy/paste within SecureView children */
+  disableCopyPaste?: boolean;
+}
+
+export interface UsePrivacyGuardReturn {
+  /** Whether screen capture is currently disabled */
+  isScreenCaptureDisabled: boolean;
+  /** Whether the screen is actively being recorded */
+  isRecording: boolean;
+  /** Disable screenshots and screen-recording preview */
+  disableScreenCapture: () => Promise<void>;
+  /** Re-enable screenshots */
+  enableScreenCapture: () => Promise<void>;
+  /** Enable app switcher blur overlay */
+  enableAppSwitcherProtection: () => Promise<void>;
+  /** Disable app switcher blur overlay */
+  disableAppSwitcherProtection: () => Promise<void>;
+  /** Clears the system clipboard */
+  clearClipboard: () => Promise<void>;
+}