@groundcover/browser 0.1.0-rc.7 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +19 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -216,6 +216,25 @@ Regardless of level (even `allow`), built-in sensitive request/response **header
216
216
  (`authorization`, `cookie`, `set-cookie`, and `token`/`key`/`secret`/`password`-like
217
217
  names) are always stripped.
218
218
 
219
+ ### Built-in sensitive patterns
220
+
221
+ These are always treated as sensitive (case-insensitive); your `sensitiveKeys` are merged in on top.
222
+
223
+ - **Key substrings** — matched as a substring of a body/query key or a DOM element attribute
224
+ (`id`/`name`/`class`/`aria-label`/`placeholder`):
225
+ `token`, `secret`, `passwd`, `password`, `api_key`, `access_key`, `write_key`, `auth`, `bearer`,
226
+ `credential`, `cvv`, `ssn`, `credit_card`, `card_number` (the `_` in the last five is optional —
227
+ `apikey` / `api-key` also match).
228
+ - **Request/response headers** — always stripped regardless of `level`: `authorization`, `cookie`,
229
+ `set-cookie`, plus any header name containing `token`, `key`, `secret`, `passwd`, `password`,
230
+ `auth`, `bearer`, or `credential`.
231
+ - **Query / form param names** — matched as a whole key (not inside JSON bodies), for OAuth-style
232
+ callbacks: `code`, `state`, `session_state`, `id_token`, `access_token`, `refresh_token`, `token`.
233
+
234
+ To opt out of body/DOM masking: `privacy: { level: "allow" }`. Built-in sensitive
235
+ headers (`authorization`/`cookie`/`set-cookie` and `token`/`key`/`secret`/`auth`-like
236
+ names) are still stripped regardless of level.
237
+
219
238
  ### Advanced
220
239
 
221
240
  - `privacy.redact(field)` — per-leaf hook for full control over non-replay
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@groundcover/browser",
3
- "version": "0.1.0-rc.7",
3
+ "version": "0.1.0",
4
4
  "description": "groundcover browser SDK",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",