@anyreplay/browser 0.1.4 → 0.2.0

package/README.md

@@ -25,12 +25,26 @@ const recorder = createRecorder({
   // maskAllInputs: true,          // off by default: field values are recorded
   // maskAllTyping: true,          // the stricter switch: fields and rich-text editors
   // maxSessionsPerMonth: 5000,    // optional cap for this project
+  // appId: 'com.example.shop',    // only inside an app shell (Capacitor, Electron); see below
 });
 
 recorder.track('checkout_clicked', { plan: 'growth' });
 recorder.identify({ userId: 'u_42', email: 'ada@example.com' });
 ```
 
+### Inside an app
+
+A page running inside a Capacitor, Cordova or Electron app has no real web
+origin — its web view reports `capacitor://localhost`, `https://localhost` or
+`file://` — so a project that lists allowed domains refuses it. Add the app's
+bundle id or package name under **Allowed apps** in the project's settings,
+and pass the same value as `appId`. Leave `appId` out on a website: from a
+real web origin it is ignored, so it cannot open a web project's domain list.
+It is a filter, not a secret.
+
+Every session also reports `platform: 'web'` and this package's name and
+version, so the dashboard can say what recorded it.
+
 Prefer a script tag? Create a project in the dashboard and copy the snippet
 from its setup page; it loads the same code from `cdn.anyreplay.com`.
 
@@ -40,8 +54,9 @@ from its setup page; it loads the same code from `cdn.anyreplay.com`.
 |---|---|
 | `createRecorder(options)` | Starts recording (or waits for consent) and returns a handle |
 | `handle.track(name, properties?)` | Tags this moment; `name` is 1–64 chars of `[A-Za-z0-9_.:-]`, properties a JSON object ≤ 4 KB |
+| `handle.trackError(error)` | Records an error you caught yourself, redacted, and marks the session as having one |
 | `handle.identify({ userId?, email? })` | Attaches your user id to the session |
-| `handle.consent(true)` | Starts recording when `requireConsent: true`; `consent(false)` keeps it off |
+| `handle.consent(true)` | Starts recording when `requireConsent: true`; `consent(false)` keeps it off, and a later `consent(true)` still starts it |
 | `handle.status()` | `idle`, `awaiting-consent`, `recording`, `sampled-out` or `stopped` |
 | `handle.flush()` | Sends what is buffered now; resolves when delivered |
 | `handle.stop()` | Stops for this page |