react-native-screenshot-aware 1.0.0 → 1.0.2

package/README.md

@@ -37,6 +37,14 @@ npm install react-native-screenshot-aware
 - Leverages the new `DETECT_SCREEN_CAPTURE` permission introduced in Android 14
 - Provides a more privacy-friendly and performant approach to screenshot detection
 
+### Permissions
+
+To use the screenshot detection feature on Android, you need to add the following permission to your `AndroidManifest.xml` file:
+
+```xml
+<uses-permission android:name="android.permission.DETECT_SCREEN_CAPTURE" />
+```
+
 > **Note**: Callbacks will never be triggered on devices running Android versions below 14. This is due to the reliance on the new `DETECT_SCREEN_CAPTURE` permission and APIs introduced in Android 14, which are not available in earlier versions.
 
 > **Note**: The decision to support only Android 14+ is based on the introduction of new, dedicated screenshot detection APIs. These APIs offer improved performance and respect user privacy better than previous methods. For more details, see the [Android 14 screenshot detection documentation](https://developer.android.com/about/versions/14/features/screenshot-detection).
@@ -84,6 +92,20 @@ useEffect(() => {
 }, [])
 ```
 
+### `removeAllListeners()`
+
+This function allows you to remove all listeners for the screenshot event.
+
+#### Example
+
+```javascript
+import ScreenshotAware from 'react-native-screenshot-aware';
+
+function removeScreenshotListeners() {
+  ScreenshotAware.removeAllListeners();
+}
+```
+
 ## Contributing
 
 We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.

package/android/src/main/java/com/screenshotaware/ScreenshotAwareModule.kt

@@ -49,6 +49,6 @@ class ScreenshotAwareModule internal constructor(context: ReactApplicationContex
 
   companion object {
     const val NAME = "ScreenshotAware"
-    const val EVENT_NAME: String = "ScreenshotEvent"
+    const val EVENT_NAME: String = "ScreenshotAwareEvent"
   }
 }

package/ios/ScreenshotAwareImpl.mm

@@ -1,13 +1,13 @@
 #import "ScreenshotAwareImpl.h"
 #import <React/RCTUtils.h>
 
-static NSString *const kRNScreenshotEventName = @"ScreenshotEvent";
+static NSString *const kRNScreenshotAwareEventName = @"ScreenshotAwareEvent";
 
 @implementation ScreenshotAwareImpl
 
 + (NSArray<NSString *> *)supportedEvents
 {
-    return @[kRNScreenshotEventName];
+    return @[kRNScreenshotAwareEventName];
 }
 
 - (instancetype)init
@@ -29,7 +29,7 @@ static NSString *const kRNScreenshotEventName = @"ScreenshotEvent";
 
 - (void)screenshotDetected:(NSNotification *)notification
 {
-    [self.delegate handleEventWithName:kRNScreenshotEventName];
+    [self.delegate handleEventWithName:kRNScreenshotAwareEventName];
 }
 
 @end

package/lib/commonjs/index.js

@@ -8,18 +8,77 @@ var _react = require("react");
 var _reactNative = require("react-native");
 var _NativeScreenshotAware = _interopRequireDefault(require("./codegenSpec/NativeScreenshotAware"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * @fileoverview This module provides functionality to detect screenshot events in a React Native application.
+ * It exports a hook for functional components and methods for class components to listen for screenshot events.
+ */
+
 const moduleEventEmitter = new _reactNative.NativeEventEmitter(_NativeScreenshotAware.default);
+
+/**
+ * A React hook that listens for screenshot events and triggers a callback when a screenshot is taken.
+ *
+ * @param {() => void} callback - The function to be called when a screenshot event occurs.
+ *
+ * @example
+ * ```jsx
+ * import { useScreenshotAware } from 'react-native-screenshot-aware';
+ *
+ * function MyComponent() {
+ *   useScreenshotAware(() => {
+ *     console.log('A screenshot was taken!');
+ *   });
+ *
+ *   return <View>...</View>;
+ * }
+ * ```
+ */
 const useScreenshotAware = callback => {
   (0, _react.useEffect)(() => {
-    const subscription = moduleEventEmitter.addListener("ScreenshotEvent", callback);
+    const subscription = moduleEventEmitter.addListener("ScreenshotAwareEvent", callback);
     return () => subscription.remove();
   }, [callback]);
 };
+
+/**
+ * Module object for managing screenshot event listeners.
+ * Useful for class components or non-React contexts.
+ *
+ * @example
+ * ```jsx
+ * import ScreenshotAware from 'react-native-screenshot-aware';
+ *
+ * class MyComponent extends React.Component {
+ *   componentDidMount() {
+ *     this.subscription = ScreenshotAware.addListener(() => {
+ *       console.log('A screenshot was taken!');
+ *     });
+ *   }
+ *
+ *   componentWillUnmount() {
+ *     this.subscription.remove();
+ *   }
+ *
+ *   render() {
+ *     return <View>...</View>;
+ *   }
+ * }
+ * ```
+ */
 exports.useScreenshotAware = useScreenshotAware;
 var _default = exports.default = {
+  /**
+   * Adds a listener for screenshot events.
+   *
+   * @param {() => void} callback - The function to be called when a screenshot event occurs.
+   * @returns {import('react-native').EmitterSubscription} A subscription object that can be used to remove the listener.
+   */
   addListener: callback => {
-    return moduleEventEmitter.addListener("ScreenshotEvent", callback);
+    return moduleEventEmitter.addListener("ScreenshotAwareEvent", callback);
   },
-  removeAllListeners: () => moduleEventEmitter.removeAllListeners("ScreenshotEvent")
+  /**
+   * Removes all listeners for screenshot events.
+   */
+  removeAllListeners: () => moduleEventEmitter.removeAllListeners("ScreenshotAwareEvent")
 };
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_react","require","_reactNative","_NativeScreenshotAware","_interopRequireDefault","e","__esModule","default","moduleEventEmitter","NativeEventEmitter","NativeScreenshotAware","useScreenshotAware","callback","useEffect","subscription","addListener","remove","exports","_default","removeAllListeners"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,sBAAA,GAAAC,sBAAA,CAAAH,OAAA;AAAwE,SAAAG,uBAAAC,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAExE,MAAMG,kBAAkB,GAAG,IAAIC,+BAAkB,CAACC,8BAAqB,CAAC;AAEjE,MAAMC,kBAAkB,GAAIC,QAAoB,IAAK;EAC1D,IAAAC,gBAAS,EAAC,MAAM;IACd,MAAMC,YAAY,GAAGN,kBAAkB,CAACO,WAAW,CACjD,iBAAiB,EACjBH,QACF,CAAC;IACD,OAAO,MAAME,YAAY,CAACE,MAAM,CAAC,CAAC;EACpC,CAAC,EAAE,CAACJ,QAAQ,CAAC,CAAC;AAChB,CAAC;AAACK,OAAA,CAAAN,kBAAA,GAAAA,kBAAA;AAAA,IAAAO,QAAA,GAAAD,OAAA,CAAAV,OAAA,GAEa;EACbQ,WAAW,EAAGH,QAAoB,IAAK;IACrC,OAAOJ,kBAAkB,CAACO,WAAW,CAAC,iBAAiB,EAAEH,QAAQ,CAAC;EACpE,CAAC;EACDO,kBAAkB,EAAEA,CAAA,KAClBX,kBAAkB,CAACW,kBAAkB,CAAC,iBAAiB;AAC3D,CAAC","ignoreList":[]}
+{"version":3,"names":["_react","require","_reactNative","_NativeScreenshotAware","_interopRequireDefault","e","__esModule","default","moduleEventEmitter","NativeEventEmitter","NativeScreenshotAware","useScreenshotAware","callback","useEffect","subscription","addListener","remove","exports","_default","removeAllListeners"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,sBAAA,GAAAC,sBAAA,CAAAH,OAAA;AAAwE,SAAAG,uBAAAC,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAExE;AACA;AACA;AACA;;AAEA,MAAMG,kBAAkB,GAAG,IAAIC,+BAAkB,CAACC,8BAAqB,CAAC;;AAExE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,kBAAkB,GAAIC,QAAoB,IAAK;EAC1D,IAAAC,gBAAS,EAAC,MAAM;IACd,MAAMC,YAAY,GAAGN,kBAAkB,CAACO,WAAW,CACjD,sBAAsB,EACtBH,QACF,CAAC;IACD,OAAO,MAAME,YAAY,CAACE,MAAM,CAAC,CAAC;EACpC,CAAC,EAAE,CAACJ,QAAQ,CAAC,CAAC;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAxBAK,OAAA,CAAAN,kBAAA,GAAAA,kBAAA;AAAA,IAAAO,QAAA,GAAAD,OAAA,CAAAV,OAAA,GAyBe;EACb;AACF;AACA;AACA;AACA;AACA;EACEQ,WAAW,EAAGH,QAAoB,IAAK;IACrC,OAAOJ,kBAAkB,CAACO,WAAW,CAAC,sBAAsB,EAAEH,QAAQ,CAAC;EACzE,CAAC;EAED;AACF;AACA;EACEO,kBAAkB,EAAEA,CAAA,KAClBX,kBAAkB,CAACW,kBAAkB,CAAC,sBAAsB;AAChE,CAAC","ignoreList":[]}

package/lib/module/index.js

@@ -3,17 +3,77 @@
 import { useEffect } from "react";
 import { NativeEventEmitter } from "react-native";
 import NativeScreenshotAware from "./codegenSpec/NativeScreenshotAware";
+
+/**
+ * @fileoverview This module provides functionality to detect screenshot events in a React Native application.
+ * It exports a hook for functional components and methods for class components to listen for screenshot events.
+ */
+
 const moduleEventEmitter = new NativeEventEmitter(NativeScreenshotAware);
+
+/**
+ * A React hook that listens for screenshot events and triggers a callback when a screenshot is taken.
+ *
+ * @param {() => void} callback - The function to be called when a screenshot event occurs.
+ *
+ * @example
+ * ```jsx
+ * import { useScreenshotAware } from 'react-native-screenshot-aware';
+ *
+ * function MyComponent() {
+ *   useScreenshotAware(() => {
+ *     console.log('A screenshot was taken!');
+ *   });
+ *
+ *   return <View>...</View>;
+ * }
+ * ```
+ */
 export const useScreenshotAware = callback => {
   useEffect(() => {
-    const subscription = moduleEventEmitter.addListener("ScreenshotEvent", callback);
+    const subscription = moduleEventEmitter.addListener("ScreenshotAwareEvent", callback);
     return () => subscription.remove();
   }, [callback]);
 };
+
+/**
+ * Module object for managing screenshot event listeners.
+ * Useful for class components or non-React contexts.
+ *
+ * @example
+ * ```jsx
+ * import ScreenshotAware from 'react-native-screenshot-aware';
+ *
+ * class MyComponent extends React.Component {
+ *   componentDidMount() {
+ *     this.subscription = ScreenshotAware.addListener(() => {
+ *       console.log('A screenshot was taken!');
+ *     });
+ *   }
+ *
+ *   componentWillUnmount() {
+ *     this.subscription.remove();
+ *   }
+ *
+ *   render() {
+ *     return <View>...</View>;
+ *   }
+ * }
+ * ```
+ */
 export default {
+  /**
+   * Adds a listener for screenshot events.
+   *
+   * @param {() => void} callback - The function to be called when a screenshot event occurs.
+   * @returns {import('react-native').EmitterSubscription} A subscription object that can be used to remove the listener.
+   */
   addListener: callback => {
-    return moduleEventEmitter.addListener("ScreenshotEvent", callback);
+    return moduleEventEmitter.addListener("ScreenshotAwareEvent", callback);
   },
-  removeAllListeners: () => moduleEventEmitter.removeAllListeners("ScreenshotEvent")
+  /**
+   * Removes all listeners for screenshot events.
+   */
+  removeAllListeners: () => moduleEventEmitter.removeAllListeners("ScreenshotAwareEvent")
 };
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["useEffect","NativeEventEmitter","NativeScreenshotAware","moduleEventEmitter","useScreenshotAware","callback","subscription","addListener","remove","removeAllListeners"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,SAAS,QAAQ,OAAO;AACjC,SAASC,kBAAkB,QAAQ,cAAc;AACjD,OAAOC,qBAAqB,MAAM,qCAAqC;AAEvE,MAAMC,kBAAkB,GAAG,IAAIF,kBAAkB,CAACC,qBAAqB,CAAC;AAExE,OAAO,MAAME,kBAAkB,GAAIC,QAAoB,IAAK;EAC1DL,SAAS,CAAC,MAAM;IACd,MAAMM,YAAY,GAAGH,kBAAkB,CAACI,WAAW,CACjD,iBAAiB,EACjBF,QACF,CAAC;IACD,OAAO,MAAMC,YAAY,CAACE,MAAM,CAAC,CAAC;EACpC,CAAC,EAAE,CAACH,QAAQ,CAAC,CAAC;AAChB,CAAC;AAED,eAAe;EACbE,WAAW,EAAGF,QAAoB,IAAK;IACrC,OAAOF,kBAAkB,CAACI,WAAW,CAAC,iBAAiB,EAAEF,QAAQ,CAAC;EACpE,CAAC;EACDI,kBAAkB,EAAEA,CAAA,KAClBN,kBAAkB,CAACM,kBAAkB,CAAC,iBAAiB;AAC3D,CAAC","ignoreList":[]}
+{"version":3,"names":["useEffect","NativeEventEmitter","NativeScreenshotAware","moduleEventEmitter","useScreenshotAware","callback","subscription","addListener","remove","removeAllListeners"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,SAAS,QAAQ,OAAO;AACjC,SAASC,kBAAkB,QAAQ,cAAc;AACjD,OAAOC,qBAAqB,MAAM,qCAAqC;;AAEvE;AACA;AACA;AACA;;AAEA,MAAMC,kBAAkB,GAAG,IAAIF,kBAAkB,CAACC,qBAAqB,CAAC;;AAExE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAME,kBAAkB,GAAIC,QAAoB,IAAK;EAC1DL,SAAS,CAAC,MAAM;IACd,MAAMM,YAAY,GAAGH,kBAAkB,CAACI,WAAW,CACjD,sBAAsB,EACtBF,QACF,CAAC;IACD,OAAO,MAAMC,YAAY,CAACE,MAAM,CAAC,CAAC;EACpC,CAAC,EAAE,CAACH,QAAQ,CAAC,CAAC;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe;EACb;AACF;AACA;AACA;AACA;AACA;EACEE,WAAW,EAAGF,QAAoB,IAAK;IACrC,OAAOF,kBAAkB,CAACI,WAAW,CAAC,sBAAsB,EAAEF,QAAQ,CAAC;EACzE,CAAC;EAED;AACF;AACA;EACEI,kBAAkB,EAAEA,CAAA,KAClBN,kBAAkB,CAACM,kBAAkB,CAAC,sBAAsB;AAChE,CAAC","ignoreList":[]}

package/lib/typescript/index.d.ts

@@ -1,6 +1,58 @@
+/**
+ * A React hook that listens for screenshot events and triggers a callback when a screenshot is taken.
+ *
+ * @param {() => void} callback - The function to be called when a screenshot event occurs.
+ *
+ * @example
+ * ```jsx
+ * import { useScreenshotAware } from 'react-native-screenshot-aware';
+ *
+ * function MyComponent() {
+ *   useScreenshotAware(() => {
+ *     console.log('A screenshot was taken!');
+ *   });
+ *
+ *   return <View>...</View>;
+ * }
+ * ```
+ */
 export declare const useScreenshotAware: (callback: () => void) => void;
+/**
+ * Module object for managing screenshot event listeners.
+ * Useful for class components or non-React contexts.
+ *
+ * @example
+ * ```jsx
+ * import ScreenshotAware from 'react-native-screenshot-aware';
+ *
+ * class MyComponent extends React.Component {
+ *   componentDidMount() {
+ *     this.subscription = ScreenshotAware.addListener(() => {
+ *       console.log('A screenshot was taken!');
+ *     });
+ *   }
+ *
+ *   componentWillUnmount() {
+ *     this.subscription.remove();
+ *   }
+ *
+ *   render() {
+ *     return <View>...</View>;
+ *   }
+ * }
+ * ```
+ */
 declare const _default: {
+    /**
+     * Adds a listener for screenshot events.
+     *
+     * @param {() => void} callback - The function to be called when a screenshot event occurs.
+     * @returns {import('react-native').EmitterSubscription} A subscription object that can be used to remove the listener.
+     */
     addListener: (callback: () => void) => import("react-native").EmitterSubscription;
+    /**
+     * Removes all listeners for screenshot events.
+     */
     removeAllListeners: () => void;
 };
 export default _default;

package/lib/typescript/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAMA,eAAO,MAAM,kBAAkB,aAAc,MAAM,IAAI,SAQtD,CAAC;;4BAGwB,MAAM,IAAI;;;AADpC,wBAME"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,kBAAkB,aAAc,MAAM,IAAI,SAQtD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;;IAED;;;;;OAKG;4BACqB,MAAM,IAAI;IAIlC;;OAEG;;;AAbL,wBAgBE"}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "react-native-screenshot-aware",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "React Native module for real-time screenshot detection on Android and iOS",
-  "source": "./src/index.tsx",
-  "main": "./lib/commonjs/index.js",
-  "react-native": "src/index.ts",
-  "module": "./lib/module/index.js",
+  "source": "src/index.tsx",
+  "main": "lib/commonjs/index.js",
+  "react-native": "src/index.tsx",
+  "module": "lib/module/index.js",
   "types": "lib/typescript/index.d.ts",
   "files": [
     "src",

package/src/index.tsx

@@ -2,22 +2,80 @@ import { useEffect } from "react";
 import { NativeEventEmitter } from "react-native";
 import NativeScreenshotAware from "./codegenSpec/NativeScreenshotAware";
 
+/**
+ * @fileoverview This module provides functionality to detect screenshot events in a React Native application.
+ * It exports a hook for functional components and methods for class components to listen for screenshot events.
+ */
+
 const moduleEventEmitter = new NativeEventEmitter(NativeScreenshotAware);
 
+/**
+ * A React hook that listens for screenshot events and triggers a callback when a screenshot is taken.
+ *
+ * @param {() => void} callback - The function to be called when a screenshot event occurs.
+ *
+ * @example
+ * ```jsx
+ * import { useScreenshotAware } from 'react-native-screenshot-aware';
+ *
+ * function MyComponent() {
+ *   useScreenshotAware(() => {
+ *     console.log('A screenshot was taken!');
+ *   });
+ *
+ *   return <View>...</View>;
+ * }
+ * ```
+ */
 export const useScreenshotAware = (callback: () => void) => {
   useEffect(() => {
     const subscription = moduleEventEmitter.addListener(
-      "ScreenshotEvent",
+      "ScreenshotAwareEvent",
       callback,
     );
     return () => subscription.remove();
   }, [callback]);
 };
 
+/**
+ * Module object for managing screenshot event listeners.
+ * Useful for class components or non-React contexts.
+ *
+ * @example
+ * ```jsx
+ * import ScreenshotAware from 'react-native-screenshot-aware';
+ *
+ * class MyComponent extends React.Component {
+ *   componentDidMount() {
+ *     this.subscription = ScreenshotAware.addListener(() => {
+ *       console.log('A screenshot was taken!');
+ *     });
+ *   }
+ *
+ *   componentWillUnmount() {
+ *     this.subscription.remove();
+ *   }
+ *
+ *   render() {
+ *     return <View>...</View>;
+ *   }
+ * }
+ * ```
+ */
 export default {
+  /**
+   * Adds a listener for screenshot events.
+   *
+   * @param {() => void} callback - The function to be called when a screenshot event occurs.
+   * @returns {import('react-native').EmitterSubscription} A subscription object that can be used to remove the listener.
+   */
   addListener: (callback: () => void) => {
-    return moduleEventEmitter.addListener("ScreenshotEvent", callback);
+    return moduleEventEmitter.addListener("ScreenshotAwareEvent", callback);
   },
+
+  /**
+   * Removes all listeners for screenshot events.
+   */
   removeAllListeners: () =>
-    moduleEventEmitter.removeAllListeners("ScreenshotEvent"),
+    moduleEventEmitter.removeAllListeners("ScreenshotAwareEvent"),
 };