fix: deprecate maskPhotoLibraryImages (#321)

* fix: deprecate maskPhotoLibraryImages * fix: update deprecation message * fix: lint * chore: revert lint * chore: update changelog
PostHog · Dec 3, 2024 · c305409 · c305409
1 parent 4452a31
commit c305409
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/posthog-react-native/CHANGELOG.md b/posthog-react-native/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Next
 
+# 3.5.0 - 2024-12-03
+
+1. fix: deprecate maskPhotoLibraryImages due to unintended masking issues
+
 # 3.4.0 - 2024-11-26
 
 1. feat: automatically mask out user photos and sandboxed views like photo picker (iOS Only)

diff --git a/posthog-react-native/package.json b/posthog-react-native/package.json
@@ -1,6 +1,6 @@
 {
   "name": "posthog-react-native",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "main": "lib/posthog-react-native/index.js",
   "files": [
     "lib/"

diff --git a/posthog-react-native/src/posthog-rn.ts b/posthog-react-native/src/posthog-rn.ts
@@ -301,7 +301,7 @@ export class PostHog extends PostHogCore {
       maskAllTextInputs = true,
       maskAllImages = true,
       maskAllSandboxedViews = true,
-      maskPhotoLibraryImages = true,
+      maskPhotoLibraryImages = false,
       captureLog = true,
       captureNetworkTelemetry = true,
       iOSdebouncerDelayMs = 1000,

diff --git a/posthog-react-native/src/types.ts b/posthog-react-native/src/types.ts
@@ -72,7 +72,9 @@ export type PostHogSessionReplayConfig = {
    * Enable masking of images that likely originated from user's photo library
    * Experimental support (UIKit only)
    * iOS only
-   * Default: true
+   * Default: false
+   *
+   * @deprecated This property has no effect and will be removed in the next major release. To learn how to manually mask user photos please see our Privacy controls documentation: https://posthog.com/docs/session-replay/privacy?tab=React+Native
    */
   maskPhotoLibraryImages?: boolean
   /**