@debugbundle/sdk-browser 0.1.0-next.0 → 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 (3) hide show
  1. package/LICENSE +17 -0
  2. package/README.md +32 -0
  3. package/package.json +15 -4
package/LICENSE ADDED
@@ -0,0 +1,17 @@
1
+ GNU AFFERO GENERAL PUBLIC LICENSE
2
+ Version 3, 19 November 2007
3
+
4
+ Copyright (C) 2024-present DebugBundle
5
+
6
+ This program is free software: you can redistribute it and/or modify
7
+ it under the terms of the GNU Affero General Public License as
8
+ published by the Free Software Foundation, either version 3 of the
9
+ License, or (at your option) any later version.
10
+
11
+ This program is distributed in the hope that it will be useful,
12
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
+ GNU Affero General Public License for more details.
15
+
16
+ You should have received a copy of the GNU Affero General Public License
17
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
package/README.md ADDED
@@ -0,0 +1,32 @@
1
+ # @debugbundle/sdk-browser
2
+
3
+ Browser SDK for DebugBundle.
4
+
5
+ Use this package to capture frontend exceptions, breadcrumbs, probe data, and browser device context. The recommended transport is the same-origin browser relay served by your backend.
6
+
7
+ ## Install
8
+
9
+ Stable npm release:
10
+
11
+ ```bash
12
+ npm install @debugbundle/sdk-browser
13
+ ```
14
+
15
+ ## Example
16
+
17
+ ```ts
18
+ import { createDebugBundleBrowserSdk } from "@debugbundle/sdk-browser";
19
+
20
+ const debugbundle = createDebugBundleBrowserSdk();
21
+
22
+ debugbundle.init({
23
+ endpoint: "/debugbundle/browser",
24
+ service: "example-web",
25
+ environment: "production"
26
+ });
27
+ ```
28
+
29
+ ## Notes
30
+
31
+ - Published from the standalone `debugbundle/debugbundle-js` repository.
32
+ - Depends on the core-owned published `@debugbundle/shared-types` and `@debugbundle/redaction` packages.
package/package.json CHANGED
@@ -1,12 +1,23 @@
1
1
  {
2
2
  "name": "@debugbundle/sdk-browser",
3
- "version": "0.1.0-next.0",
3
+ "version": "0.1.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "license": "AGPL-3.0-only",
7
7
  "description": "Browser SDK for DebugBundle",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/debugbundle/debugbundle-js.git",
11
+ "directory": "packages/sdk-browser"
12
+ },
13
+ "bugs": {
14
+ "url": "https://github.com/debugbundle/debugbundle-js/issues"
15
+ },
16
+ "homepage": "https://github.com/debugbundle/debugbundle-js/tree/main/packages/sdk-browser",
8
17
  "files": [
9
- "dist"
18
+ "dist",
19
+ "README.md",
20
+ "LICENSE"
10
21
  ],
11
22
  "main": "./dist/index.js",
12
23
  "types": "./dist/index.d.ts",
@@ -20,7 +31,7 @@
20
31
  "access": "public"
21
32
  },
22
33
  "dependencies": {
23
- "@debugbundle/shared-types": "0.1.0-next.0",
24
- "@debugbundle/redaction": "0.1.0-next.0"
34
+ "@debugbundle/shared-types": "0.1.0",
35
+ "@debugbundle/redaction": "0.1.0"
25
36
  }
26
37
  }