@xysfe/bug-tap 0.1.1 → 0.1.3

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.
@@ -71,7 +71,8 @@ BugTap.init({
71
71
  {
72
72
  "project": "demo-project",
73
73
  "environment": "production",
74
- "sdkVersion": "0.1.0",
74
+ "libVersion": "0.1.2",
75
+ "sdkVersion": "0.1.2",
75
76
  "clientReportId": "5f0c2e2a-...",
76
77
  "release": "1.2.3+abc1234",
77
78
  "fingerprint": "bt-1a2b3c4d",
@@ -223,6 +224,7 @@ BugTap.init({
223
224
 
224
225
  补充约定:
225
226
 
227
+ - `libVersion` 与 `sdkVersion` 同值,两个名字并存:`libVersion` 是与 `xys-util` 的 `RealTimeReport` 打通用的字段(日志平台按它区分「这条来自哪个上报库」),`sdkVersion` 是 SDK 自身一直沿用的名字,已有的查询与看板依赖它,不做替换
226
228
  - `browser.dpr` 归一化到 2 位小数(`devicePixelRatio` 在缩放场景下会带浮点噪声,如 `1.100000023841858`),`device` 使用同一个归一化值,保证同一设备在日志平台聚合到同一个键
227
229
  - `page.url` 与顶层 `url` 相同时不下发(顶层 `url` 的取值就是 `page.url`,为空时才回退 `location.href`);要用页面地址请取顶层 `url`
228
230
  - `page.referrer` 与 `page.url` 相同时不下发(刷新页面的常见场景)
package/docs/bundler.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # 打包器接入
2
2
 
3
- 本 SDK 同时提供 ESM 与 CJS 两种产物,`exports` 里 `import` / `require` 两个条件都覆盖了(与 `@sentry/browser`、`zod` 的做法一致)。两者都把 `vue`、`html2canvas-pro`、`css-selector-generator` 作为 external,交由业务打包器处理。不同打包器与版本需要的配置不同,下面是在真实环境中验证过的组合。
3
+ 本 SDK 同时提供 ESM 与 CJS 两种产物,`exports` 里 `import` / `require` 两个条件都覆盖了(与 `@sentry/browser`、`zod` 的做法一致)。两者把 `html2canvas-pro`、`css-selector-generator` 作为 external,交由业务打包器处理;Vue 3 运行时内联在面板 chunk 里。不同打包器与版本需要的配置不同,下面是在真实环境中验证过的组合。
4
4
 
5
5
  ## 结论速查
6
6
 
@@ -13,19 +13,18 @@
13
13
  | Vue CLI 4(webpack 4) | 需配置 | `require` | 见下 |
14
14
  | Jest / 其他 CJS 运行环境 | 是 | `require` | 无 |
15
15
 
16
- > **关于 `vue`**:面板 chunk(`panel-mount-*.js` / `.cjs`)里有 `import 'vue'`,而它是通过动态 import 加载的。
17
- > 打包器做静态分析时会解析整张 chunk 图,所以 ESM / CJS 接入方**必须安装 `vue`**(与项目版本一致),
18
- > 即使 `reporter.enabled: false` 也一样。不想引入 Vue 依赖时用 IIFE 产物(已内联 Vue 3 runtime)。
16
+ > **关于 `vue`**:面板用 Vue 3 的 `createApp` 渲染,Vue 3 运行时已内联在面板 chunk
17
+ > (`panel-mount-*.js` / `.cjs`)里。接入方**不需要安装 `vue`**,也没有 peer 依赖;
18
+ > 项目自身是 Vue 2.7 也能正常使用悬浮面板,不会被打包器的 `vue$` alias 改写。
19
19
  >
20
- > 面板用 Vue 3 的 `createApp`,因此 ESM / CJS 产物要求 Vue 3(peer 声明 `>=3.2 <4`)。
21
- > Vue 2 项目想用反馈面板请走 IIFE 产物;只把 `@xysfe/bug-tap/vue` 当采集插件时可以留在 Vue 2.7。
20
+ > 面板通过动态 import 加载,Vue 3 只随首次打开面板下载(约 35 KB gzip),首屏不受影响。
22
21
 
23
22
  ## webpack 5 / Vite
24
23
 
25
24
  无需任何配置。
26
25
 
27
26
  已验证:`import { init } from '@xysfe/bug-tap'` 与 `import BugTapVue from '@xysfe/bug-tap/vue'` 都能直接解析;
28
- `html2canvas-pro` 与 Vue 会被自动拆成独立 chunk,首屏不加载。
27
+ `html2canvas-pro` 会被自动拆成独立 chunk,首屏不加载;Vue 3 随面板 chunk 按需加载。
29
28
 
30
29
  ## webpack 4 / Vue CLI 4
31
30
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xysfe/bug-tap",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "可嵌入网页的调试与 Bug 上报 SDK:独立悬浮上报入口,自动采集 Console、JS 异常、Network 与环境信息",
5
5
  "repository": {
6
6
  "type": "git",
@@ -70,14 +70,6 @@
70
70
  "css-selector-generator": "^3.9.4",
71
71
  "html2canvas-pro": "^1.6.7"
72
72
  },
73
- "peerDependencies": {
74
- "vue": ">=3.2 <4"
75
- },
76
- "peerDependenciesMeta": {
77
- "vue": {
78
- "optional": true
79
- }
80
- },
81
73
  "devDependencies": {
82
74
  "@playwright/test": "^1.65.0",
83
75
  "@types/node": "^22.0.0",