@flareapp/js 1.2.1 → 2.0.0

package/CHANGELOG.md

@@ -1,30 +1,33 @@
-# @flareapp/js
-
-## 1.2.0
-
-This is the **final v1 release**. Subsequent work ships under v2.
-
-### Added
-- Reports are now mapped to the Flare v2 wire format on egress. The mapper sits at the `Api.report()` boundary; the public API and the `beforeSubmit` hook still see the v1 `Report` shape.
-
-### Changed
-- Default `reportingUrl` now points to the new ingestion endpoint: `https://ingress.flareapp.io/v1/errors`. Consumers with allowlist firewall rules on outbound HTTP must add this host to their allowlist. Consumers passing a custom `reportingUrl` to `flare.configure({...})` are unaffected.
-- HTTP response is now treated as success on status `200`, `201`, or `204` (previously only `204`).
-- Headers updated: `Accept: application/json` and `X-Flare-Client-Version: 1` added; `X-Requested-With` removed. `X-Api-Token` and `X-Report-Browser-Extension-Errors` retained.
-- Stack frames omit the `class` field when empty (previously emitted as `""`). The field is still emitted when populated.
-
-### Fixed
-- `cookie` context collector preserves `=` characters inside cookie values (previously truncated base64-padded values at the first `=`).
-- Global error and unhandled-rejection handlers attach via `addEventListener`, so user code reassigning `window.onerror` no longer detaches Flare's handlers.
-- Non-Error rejection reasons (strings, plain objects, Symbols) now produce reports instead of being silently dropped.
-- `flatJsonStringify` decycles via a `WeakSet` of ancestor objects: real cycles become the literal `'[Circular]'`; non-cyclic shared sub-objects are preserved without recursion blowup.
-- `createStackTrace` wraps `ErrorStackParser.parse` in `try/catch`. Parser failures resolve to a single fallback frame instead of dropping the report.
-
-### Internal
-- New `mapToV2Wire(report, config)` pure function in `src/api/mapToV2Wire.ts`.
-- New `glowsToEvents(glows)` helper in `src/util/glowsToEvents.ts`.
-- `Api.report()` signature changed from `(report, url, key, reportBrowserExtensionErrors)` to `(report, config)`. This is internal — it is not part of the package's public exports.
-
-## 1.1.0
-
-Prior history is in git.
+## 2.0.0
+
+### Breaking changes
+
+- **Endpoint changed.** SDK now POSTs to `https://ingress.flareapp.io/v1/errors`. Success response is `201 Created`. Auth header is `x-api-token`.
+- **Wire format reshaped to match the server's canonical schema.**
+    - `Report` uses camelCase top-level fields (`exceptionClass`, `seenAtUnixNano`, `sourcemapVersionId`, `isLog`, `level`, `attributes`, `events`).
+    - `StackFrame` uses camelCase (`lineNumber`, `columnNumber`, `codeSnippet`, `isApplicationFrame`).
+    - `Context` is gone. User context is set via `addContext(name, value)` and `addContextGroup(group, value)`; both write into the flat `attributes` map under `context.custom` and `context.<group>`.
+    - Glows ride along as `php_glow`-typed entries in `events[]`.
+- **`report()` second argument** is now an `Attributes` map (was a freeform context object). The third argument (solution provider parameters) is removed.
+- **Config keys renamed:** `reportingUrl` → `ingestUrl`, `sourcemapVersion` → `sourcemapVersionId`.
+- **Deprecated trailing setters removed:** `flare.beforeEvaluate = …`, `flare.beforeSubmit = …`, `flare.stage = …`. Use `flare.configure({ … })`.
+- **`reportMessage` signature changed:** `reportMessage(message, level?, attributes?)`. The old `'Log INFO'` regex is gone, pass `level` directly.
+- **Solutions API removed:** `registerSolutionProvider`, `Solution`, `SolutionProvider`, `SolutionProviderExtraParameters` are all deleted.
+- **`flare.config` is now `Readonly<Config>`** and `flare.glows` is `readonly Glow[]`. Direct property mutation no longer works; use `configure()`.
+
+### New
+
+- **URL redaction.** Sensitive query-string parameters (`password`, `token`, `secret`, `authorization`, etc.) are automatically replaced with `[redacted]` in `url.full`, `url.query`, and `flare.entry_point.value` attributes. Configurable via `urlDenylist` (custom regex) and `replaceDefaultUrlDenylist` (boolean) config options.
+- `DEFAULT_URL_DENYLIST`, `redactFullPath`, and `resolveDenylist` are exported for direct use by framework adapters.
+- `setEntryPoint({ identifier?, name?, type? })` — mutable global setter for the entry-point handler. SPA framework adapters call this on every navigation.
+- `setSdkInfo({ name, version })` — overridable SDK identity (default `@flareapp/js` + client version). Integrations override it.
+- `setFramework({ name, version? })` — host framework attribution (e.g. React, Vue).
+- `code` field auto-populated from `error.code` when present (string, ≤64 chars).
+- Non-`Error` values passed to `report()` are coerced to `Error` instead of silently failing.
+- Browser context attributes (`url.full`, `url.query`, `browser.user_agent`, `browser.viewport.*`, cookies, request data) are auto-collected on each report.
+- New exported types: `SpanEvent`, `EntryPointHandler`, `Framework`, `SdkInfo`, `OverriddenGrouping`, `Attributes`, `AttributeValue`.
+- **`sampleRate` config option.** Number between `0` and `1` (default `1`). Controls what fraction of errors are reported. Applies to `report()`, `reportMessage()`, and `reportUnhandledRejection()`.
+
+### Notes
+
+- `seenAtUnixNano` is now real nanoseconds (`Date.now() * 1_000_000`).

package/README.md

@@ -1,9 +1,30 @@
-# The JavaScript client for Flare to catch frontend errors
+# @flareapp/js
 
-Read the JavaScript error tracking section in [the Flare documentation](https://flareapp.io/docs/javascript-error-tracking/installation) for more information.
+The core JavaScript/TypeScript client for [Flare](https://flareapp.io) error tracking. Captures frontend errors, parses
+stack traces, collects browser context, and reports everything to the Flare backend.
 
-React plugin: https://www.npmjs.com/package/@flareapp/react
+## Installation
 
-Vue plugin: https://www.npmjs.com/package/@flareapp/vue
+```bash
+npm install @flareapp/js
+```
 
-Webpack plugin: https://www.npmjs.com/package/@flareapp/flare-webpack-plugin-sourcemap
+## Quick start
+
+```js
+import { flare } from '@flareapp/js';
+
+flare.light('YOUR_FLARE_API_KEY');
+```
+
+That is all you need. The client automatically listens for uncaught exceptions and unhandled promise rejections,
+collects browser context, and sends error reports to Flare.
+
+## Documentation
+
+Full documentation on configuration, hooks, context, breadcrumbs, solution providers, and more is available
+at [flareapp.io/docs/javascript/general/installation](https://flareapp.io/docs/javascript/general/installation).
+
+## License
+
+The MIT License (MIT). Please see [License File](../../LICENSE.md) for more information.