@monoscopetech/browser 0.4.3 → 0.4.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Monoscopetech
+
+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,108 @@
+# Monoscope Browser SDK
+
+The **Monoscope Browser SDK** is a lightweight JavaScript library for adding **session replay**, **performance tracing**, and **frontend logging** to your web applications.
+
+When used together with the [Monoscope Server SDKs](https://apitoolkit.io/docs/sdks/), you gain **end-to-end observability** — seamlessly connecting user interactions in the browser to backend services, APIs, and databases.
+
+This means you can:
+
+- **Replay user sessions** to see exactly what happened.
+- **Trace requests** from the frontend, through your backend, and into your database.
+- **Capture logs and errors** with full context for faster debugging.
+
+With the sdk, you can seamlessly monitor how users interact with your app, measure performance, and gain insights into issues — all in one place.
+
+---
+
+## Installation
+
+Install via **npm/bun**:
+
+```bash
+npm install @monoscopetech/browser
+```
+
+Or include it directly in your HTML using a `<script>` tag:
+
+```html
+<script src="https://unpkg.com/@monoscopetech/browser@latest/dist/monoscope.min.js"></script>
+```
+
+---
+
+## Quick Start
+
+Initialize Monoscope with your **project ID** and configuration:
+
+```javascript
+import Monoscope from "@monoscopetech/browser";
+
+const monoscope = new Monoscope({
+  projectId: "YOUR_PROJECT_ID",
+  serviceName: "my-web-app",
+  // ...other configuration options
+});
+```
+
+---
+
+## Configuration
+
+The `Monoscope` constructor accepts the following options:
+
+| Name                           | Type                  | Description                                                                  |
+| ------------------------------ | --------------------- | ---------------------------------------------------------------------------- |
+| `projectId`                    | `string`              | **Required** – Your Monoscope project ID.                                    |
+| `serviceName`                  | `string`              | **Required** – Name of your service or application.                          |
+| `exporterEndpoint`             | `string`              | Endpoint for exporting traces/logs. Defaults to Monoscope's ingest endpoint. |
+| `propagateTraceHeaderCorsUrls` | `RegExp[]`            | Array of regex patterns for URLs where trace headers should be propagated.   |
+| `resourceAttributes`           | `Record<string, any>` | Additional resource-level attributes.                                        |
+| `instrumentations`             | `any[]`               | OpenTelemetry instrumentations to enable.                                    |
+| `replayEventsBaseUrl`          | `string`              | Base URL for session replay events. Defaults to Monoscope's ingest endpoint. |
+| `user`                         | `MonoscopeUser`       | Default user information for the session.                                    |
+
+---
+
+### User Object
+
+The `MonoscopeUser` object can contain:
+
+| Name       | Type       | Description               |
+| ---------- | ---------- | ------------------------- |
+| `email`    | `string`   | User's email address.     |
+| `fullName` | `string`   | User's full name.         |
+| `name`     | `string`   | User's preferred name.    |
+| `id`       | `string`   | User's unique identifier. |
+| `roles`    | `string[]` | User's roles.             |
+
+---
+
+## API
+
+### `setUser(user: MonoscopeUser)`
+
+Associates the given user with the current session.
+
+```javascript
+monoscope.setUser({
+  id: "user-123",
+  email: "user@example.com",
+});
+```
+
+---
+
+### `getSessionId(): string`
+
+Retrieves the current session ID — useful for tagging custom spans or events.
+
+```javascript
+const sessionId = monoscope.getSessionId();
+console.log(sessionId);
+```
+
+---
+
+## License
+
+This SDK is licensed under the [MIT License](LICENSE).

package/dist/types.d.ts

@@ -11,7 +11,7 @@ export type MonoscopeConfig = {
 };
 export type MonoscopeUser = {
     email?: string;
-    fullName?: string;
+    full_name?: string;
     name?: string;
     id?: string;
     roles?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monoscopetech/browser",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",