@getexception/browser 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GetException contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# @getexception/browser
+
+Browser error monitoring for your own GetException server. Captures unhandled exceptions and promise rejections, and provides a small API for reporting handled errors.
+
+## Install
+
+```bash
+yarn add --exact @getexception/browser
+```
+
+For React applications, install [`@getexception/react`](https://www.npmjs.com/package/@getexception/react) instead; it includes the browser SDK and a React `ErrorBoundary`.
+
+## Initialize
+
+Create a project in GetException, configure its **Allowed origins**, and save the DSN. Initialize once in the browser entry point. With Vite:
+
+```ts
+import * as GetException from "@getexception/browser";
+
+GetException.init({
+  dsn: import.meta.env.VITE_GETEXCEPTION_DSN,
+  environment: "production",
+});
+
+GetException.captureException(new Error("GetException connection test"));
+```
+
+Use your installation's separate HTTPS ingest domain in the DSN. It must resolve and have a valid certificate before errors can reach the server. Add the ingest origin to CSP `connect-src` if your application uses CSP. The DSN is a public, write-only project key and does not grant access to the dashboard.
+
+## Configuration
+
+| Option        | Meaning                                                               |
+| ------------- | --------------------------------------------------------------------- |
+| `dsn`         | Required HTTPS project DSN from GetException.                         |
+| `environment` | `production`, `staging` or `development` (default).                   |
+| `release`     | Optional `<project-slug>@<full 40-character Git SHA>`.                |
+| `dist`        | Optional build identifier, up to 64 letters, digits, `.`, `_` or `-`. |
+| `enabled`     | Set to `false` to skip initialization.                                |
+
+Importing the package does not initialize monitoring. Invalid configuration disables sending without throwing into the application. Calling `init` again while the client is active does nothing; use `close` before initializing another client.
+
+## Manual capture and context
+
+```ts
+GetException.withScope((scope) => {
+  scope.setTag("feature", "editor");
+  scope.setTag("operation", "save");
+  scope.setContext("app", { route: "/documents" });
+  GetException.captureException(new Error("Document save failed"));
+});
+
+GetException.captureMessage("Upload failed", "error");
+await GetException.flush(1500);
+```
+
+`captureException` and `captureMessage` return an event ID, or an empty string when inactive. An event ID does not confirm delivery. `captureMessage` supports only `error` and `fatal`. `flush` waits for local work to finish; it does not guarantee acceptance or processing by the server. `close` shuts down the client. Both return `Promise<boolean>` and cap waiting at two seconds.
+
+Tags are limited to `feature`, `component` and `operation`. Context is limited to `app.route`, with query strings and fragments removed. Manual breadcrumbs support `navigation`, `http` and `manual` with allowed fields only. See the [compatibility guide](https://github.com/GetException/GetException/blob/stable/docs/sdk-compatibility.md) before replacing Sentry imports through npm aliases.
+
+## Privacy and scope
+
+The client uses a restricted Sentry integration and cleans event data before sending. The server independently validates and cleans it again. Requests omit cookies and referrers. Network failures do not throw into your application; the client limits pending requests and backs off after HTTP 429.
+
+No replay, tracing, user identity, automatic console/DOM breadcrumbs, cookies, form data, local storage, attachments or arbitrary context are collected. Avoid putting credentials or personal data in error messages. Source map upload and symbolication are not yet implemented.
+
+This package targets modern browsers, is ESM and includes TypeScript declarations. It is not a Node.js SDK.
+
+## License
+
+MIT. See `THIRD-PARTY-NOTICES.md` for the underlying Sentry SDK and bundled dependencies.

package/THIRD-PARTY-NOTICES.md

@@ -0,0 +1,7 @@
+# Third-party notices
+
+The SDK uses the official MIT-licensed Sentry JavaScript SDK 10.73.0, copyright
+Sentry and contributors. Its npm dependencies retain their original LICENSE files.
+The browser bundle includes GetException protocol (MIT) and Zod (MIT),
+copyright Colin McDonnell and contributors. The MIT permission and warranty
+notice is reproduced in LICENSE and applies to these bundled portions as well.

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+type SeverityLevel = "error" | "fatal";
+interface BrowserOptions {
+    dsn: string;
+    release?: string;
+    environment?: "production" | "staging" | "development";
+    dist?: string;
+    enabled?: boolean;
+}
+interface Breadcrumb {
+    category?: string;
+    timestamp?: number;
+    data?: Record<string, unknown>;
+}
+interface Scope {
+    setTag(key: string, value: string | number | boolean): void;
+    setTags(tags: Record<string, string | number | boolean>): void;
+    setContext(name: string, context: Record<string, unknown> | null): void;
+    addBreadcrumb(breadcrumb: Breadcrumb): void;
+}
+declare function dsnEndpoint(dsn: string): string;
+/** Unsupported options are ignored; only this allow-list is ever passed to Sentry. */
+declare function init(options?: BrowserOptions): void;
+declare function captureException(exception: unknown): string;
+/** Unsupported levels explicitly produce no event and return an empty ID. */
+declare function captureMessage(message: string, level?: SeverityLevel): string;
+declare function setTag(key: string, value: string | number | boolean): void;
+declare function setTags(tags: Record<string, string | number | boolean>): void;
+declare function setContext(name: string, context: Record<string, unknown> | null): void;
+declare function addBreadcrumb(breadcrumb: Breadcrumb): void;
+declare function withScope<T>(callback: (scope: Scope) => T): T;
+declare function flush(timeout?: number): Promise<boolean>;
+declare function close(timeout?: number): Promise<boolean>;
+
+export { type Breadcrumb, type BrowserOptions, type Scope, type SeverityLevel, addBreadcrumb, captureException, captureMessage, close, dsnEndpoint, flush, init, setContext, setTag, setTags, withScope };