@blipit/react-native 0.2.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ ## 0.4.0
2
+
3
+ - Stuck screens and flows: `waitForReady` with `Blipit.reportReady()`, and `startFlow`, `flowStep` and `endFlow`. When the app never reaches its first usable screen, or a flow such as sign-in never finishes, Blipit opens a Stuck issue with the last step and the steps before it. Only time on screen counts; the time limits come from Blipit.
4
+
5
+ ## 0.3.0
6
+
7
+ - `<BlipitReporter showButton>` around your app and `showReport()` from your own menu open the bug reporter: Take a screenshot or Skip, then a full-screen editor with the tools above and below the image, pinch, two-finger pan and double-tap zoom up to 5x, pen, box and arrow marks, then a title, what happened and an optional email, and Send. Screenshots need `react-native-view-shot` (optional peer dependency); without it the report is sent as text.
8
+
1
9
  ## 0.2.1
2
10
 
3
11
  - Events carry the `npm:@blipit/react-native` package and version, so the dashboard can show when this app runs an old Blipit SDK. A `beforeSend` you pass still runs after it. `VERSION` is exported.
package/README.md CHANGED
@@ -37,6 +37,52 @@ Blipit.captureSecurity("login_failed", "ana@example.com", { ip: "10.0.0.1" });
37
37
  await Blipit.flush();
38
38
  ```
39
39
 
40
+ ## Bug reports
41
+
42
+ Install `react-native-view-shot` for screenshots, wrap your app in `BlipitReporter` (`showButton` adds the floating Report a bug button) and call `showReport()` from your own menu:
43
+
44
+ ```tsx
45
+ npm install react-native-view-shot
46
+
47
+ export default Blipit.wrap(() => (
48
+ <Blipit.BlipitReporter showButton>
49
+ <App />
50
+ </Blipit.BlipitReporter>
51
+ ));
52
+
53
+ Blipit.showReport();
54
+ ```
55
+
56
+ The reporter asks first: Take a screenshot or Skip. The screenshot opens full screen with the tools above and below it; pinch or double-tap to zoom, mark the problem, then add a title and what happened and send. Without `react-native-view-shot` the report is sent as text. Reports arrive under Bug reports at app.blipit.io.
57
+
58
+ ## Stuck screens and flows
59
+
60
+ Some failures never crash: the splash screen keeps spinning, or a sign-in promise never settles. Tell Blipit when the app is ready and wrap the flows that must finish:
61
+
62
+ ```tsx
63
+ Blipit.init({ key: "<public key>", project: <project id>, waitForReady: true });
64
+
65
+ Blipit.reportReady();
66
+
67
+ Blipit.startFlow("sign-in");
68
+ Blipit.flowStep("sign-in", "google-picker");
69
+ Blipit.endFlow("sign-in");
70
+ ```
71
+
72
+ With `waitForReady: true`, call `Blipit.reportReady()` once the first usable screen shows, for example in the first screen's effect after its data loads.
73
+
74
+ If one does not finish in time, Blipit opens a **Stuck** issue with the flow, the last step, the screen when it is known, how long it waited and the steps before it. Only time on screen counts: while the app is in the background the clock stops, so a sign-in that sends people to a browser is not cut short. Blipit sets the time limits on its side and the SDK picks them up with its settings, so they can change without an app release. Nothing is decided before those settings arrive.
75
+
76
+ Call `startFlow` when the person starts the action (taps Continue with Google), not when the screen opens. `endFlow` covers every way out, including the person cancelling. Flow and step names are sent as you write them: use fixed names such as `sign-in` or `google-picker`, never emails, phone numbers or other personal data.
77
+
78
+ ## Store declarations
79
+
80
+ What to declare when you ship an app with Blipit:
81
+
82
+ - **Apple App Store**: the native crash library inside the package ships its own privacy manifest, and Blipit's JavaScript code uses no required-reason APIs. In App Store Connect, App Privacy, declare crash data, performance data and other diagnostic data under App Functionality, not linked, no tracking. Blipit uses no IDFA, no App Tracking Transparency prompt and no background modes. If you call `setUser` with an id or email, declare those as linked to the person.
83
+ - **Google Play**: in the Data safety form declare App info and performance, Crash logs and Diagnostics: collected, not shared, processed in transit with encryption, not optional, for App functionality and Analytics. Blipit adds no permissions, reads no Android ID, IMEI or advertising id, and starts no WorkManager job or foreground service. If you call `setUser`, also declare User IDs or Email address.
84
+ - **Huawei AppGallery**: the Android path needs neither Google Play services nor HMS Core. In your privacy statement, list crash and diagnostic data sent to Blipit (Louward Labs FZC LLC) for app stability, and the same items in the AppGallery Connect privacy section.
85
+
40
86
  ## Performance
41
87
 
42
88
  Pass `tracesSampleRate: 0.2` to `init` and screen loads and requests show up on the Performance page.