@pluve/logger-sdk 0.0.12 → 0.0.14

package/README.md

@@ -12,33 +12,26 @@
 ## 快速开始
 
 ```ts
-import { LoggerSDK } from './core/loggerSDK';
+import { LoggerSDK } from '@pluve/logger-sdk';
 
 const sdk = LoggerSDK.getInstance();
 
 sdk.init({
-  // endpoint: 'https://logger.yfpharmacy.com/log', // 实际使用以 config 中 API 为准
-  appId: 'fe-vue-pc-seed-frontend',
-  env: 'develop',
-  logStage: 'develop',
-  debug: true,
-  // 采集与性能
+  appId: 'app',
+  logStage: 'product',
+  debug: false,
   enableGzip: true,
-  enableBatch: true,
-  batchSize: 10,
+  enableBatch: false,
+  batchSize: 20,
   batchInterval: 15000,
   maxPixelUrlLen: 8192,
-  // 重试
-  enableRetry: true,
-  maxRetries: 3,
-  retryDelay: 1000,
-  retryBackoff: true,
-  // 身份与鉴权
+  enableRetry: false,
   userId: 'u-001',
   storeCode: 's-001',
   token: '<token>',
-  // 采样率（可选）
   sampleRate: 1,
+  enableAutoCapture: true,
+  autoCapture: { js: true, promise: true, resource: true, wechat: true },
 });
 
 // 业务日志
@@ -64,16 +57,18 @@ sdk.setStage('testing');
 - enableStorage：队列持久化开关（默认 true）
 - enableRetry/maxRetries/retryDelay/retryBackoff：重试相关配置
 - sampleRate/levelSampleRate/sourceSampleRate/pathSampleRate：采样配置
+- enableAutoCapture：自动采集总开关（默认开启）
+- autoCapture：细粒度开关 { js, promise, resource, wechat }
 
-详细定义参考类型文件：[sdkOptions.ts](src/pages/logger-sdk-tester/logger-sdk-v2/types/sdkOptions.ts).
+详细定义参考类型文件：[sdkOptions.ts](./src/types/sdkOptions.ts).
 
 ## 压缩实现
 
 - gzipCompress(data)
   - 浏览器支持 CompressionStream 时，流式 gzip 压缩，再转 Base64 字符串
-  - 不支持时，回退到 fflate.gzipSync(默认压缩级别)，转 Base64
+  - 不支持时，回退到 fflate.gzipSync，使用 btoa/Buffer 生成 Base64
   - 返回值为 Base64 字符串，适用于传输（像素图 URL/JSON 体）
-- 代码参考：[compression.ts](src/pages/logger-sdk-tester/logger-sdk-v2/compress/compression.ts).
+- 代码参考：[compression.ts](./src/compress/compression.ts).
 - 备注：当前默认压缩级别，无级别可调参数暴露；如需级别控制可在 fflate 路径引入配置。
 
 ## 传输适配
@@ -85,7 +80,7 @@ sdk.setStage('testing');
   - 请求体字符串化 safeStringify
   - enableGzip 时使用 gzipCompress 生成 Base64，Content-Type 设为 `application/json; charset=utf-8`
 - PixelImageTransport
-  - 字符串化 items，enableGzip 时压缩为 Base64，URL 参数附带 `gzip=1`
+  - 字符串化 items，enableGzip 时压缩为 Base64；非 gzip 情况下优先使用全局 Base64，其次 btoa，再次 encodeURIComponent；URL 参数附带 `gzip=1`
   - 构造像素上报 URL（含 appId、appStage、items、cacheBuster）
   - URL 超长打印警告
 - BeaconTransport
@@ -93,26 +88,26 @@ sdk.setStage('testing');
 
 代码参考：
 
-- 适配器选择：[transportAdapter.ts](src/pages/logger-sdk-tester/logger-sdk-v2/transport/transportAdapter.ts)
-- WeChat：[wechatTransport.ts](src/pages/logger-sdk-tester/logger-sdk-v2/transport/wechatTransport.ts)
-- Pixel Image：[pixelImageTransport.ts](src/pages/logger-sdk-tester/logger-sdk-v2/transport/pixelImageTransport.ts)
-- Beacon：[beaconTransport.ts](src/pages/logger-sdk-tester/logger-sdk-v2/transport/beaconTransport.ts)
+- 适配器选择：[transportAdapter.ts](./src/transport/transportAdapter.ts)
+- WeChat：[wechatTransport.ts](./src/transport/wechatTransport.ts)
+- Pixel Image：[pixelImageTransport.ts](./src/transport/pixelImageTransport.ts)
+- Beacon：[beaconTransport.ts](./src/transport/beaconTransport.ts)
 
 ## 批量与队列
 
 - 启用批量后，事件入队，当队列大小达到 batchSize 或定时器触发时 flush
 - flush：按 appId|stage 分组与分块（最多 200/块），批量发送成功后出队
-- 队列持久化：localforage 存储，页面刷新/卸载可恢复
+- 队列持久化：优先 IndexedDB（localforage），失败回退 localStorage；仅在浏览器环境启用
 - 页面事件触发 flush：visibilitychange（hidden）、pagehide、beforeunload
 - 代码参考：
-  - [queueManager.ts](src/pages/logger-sdk-tester/logger-sdk-v2/core/queueManager.ts)
-  - [loggerSDK.ts（flush/sendBatch）](src/pages/logger-sdk-tester/logger-sdk-v2/core/loggerSDK.ts#L452-L485)
+  - [queueManager.ts](./src/core/queueManager.ts)
+  - [loggerSDK.ts（flush/sendBatch）](./src/core/loggerSDK.ts#L394-L467)
 
 ## 重试策略
 
 - 单个事件 sendEvent 与批量 sendBatch 均支持 executeWithRetry
 - 可配置最大次数、基础延迟、指数退避
-- 代码参考：[retryManager.ts](src/pages/logger-sdk-tester/logger-sdk-v2/core/retryManager.ts)
+- 代码参考：[retryManager.ts](./src/core/retryManager.ts)
 
 ## 采样与开关
 
@@ -124,13 +119,13 @@ sdk.setStage('testing');
   - 综合 level/source/path/global 采样率
   - 基于 seed 哈希概率决定是否发送
 - 参考：
-  - [loggerSDK.ts（shouldSend）](src/pages/logger-sdk-tester/logger-sdk-v2/core/loggerSDK.ts#L348-L411)
-  - [api.ts](src/pages/logger-sdk-tester/logger-sdk-v2/types/api.ts)
+  - [loggerSDK.ts（shouldSend）](./src/core/loggerSDK.ts#L324-L365)
+  - [api.ts](./src/types/api.ts)
 
 ## 数据格式
 
 - LogEvent：标准化日志格式（logId/seq/appId/stage/level/traceId/frontendId/url/location/message/throwable/userId/storeCode/tags）
-  - 类型参考：[logEvent.ts](src/pages/logger-sdk-tester/logger-sdk-v2/types/logEvent.ts)
+  - 类型参考：[logEvent.ts](./src/types/logEvent.ts)
 - ReportData：上报批次（appId/appStage/items[]）
 
 ## 限制与注意
@@ -139,8 +134,16 @@ sdk.setStage('testing');
 - 像素图：URL 长度受限；压缩可显著降低长度但 Base64 会比二进制略增
 - 压缩：CompressionStream 不提供压缩级别参数；fflate 同步压缩适合小批量数据
 - 安全：不要在日志中包含敏感数据（token、密码、隐私信息等）
+- 依赖：js-base64、localforage 均为 peerDependencies；UMD 外部化由应用或 CDN 提供全局；ESM/CJS 下由应用安装解析
 
 ## 流程图
 
 - 完整 Mermaid 流程图见文件：
-  - [logger-sdk.mermaid](src/pages/logger-sdk-tester/logger-sdk-v2/logger-sdk.mermaid)
+  - [logger-sdk.mermaid](./src/logger-sdk.mermaid)
+  - [logger-sdk.svg](./src/logger-sdk.svg)
+
+## 类型与打包
+
+- 类型入口：package.json exports.types 与 typesVersions 指向 dist/types
+- TypeScript 解析：推荐在应用设置 moduleResolution: "bundler" 或 "nodenext"/"node16"
+- 声明构建：`yarn build-types`（tsconfig.types.json 禁用默认 @types 扫描，避免冲突）

package/dist/esm/capture/jsError.js

@@ -1,42 +1,21 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
 // src/capture/jsError.ts
 import { parseStack } from "../stack/stacktrace";
 import { logDebug } from "../utils/tools";
 function registerJsErrorCapture(debug, callback) {
   if (typeof window === "undefined")
     return void 0;
-  const handler = (e) => __async(this, null, function* () {
+  const handler = async (e) => {
     logDebug(debug, "registerJsErrorCapture error", e);
     if (!e.error)
       return;
-    const stack = yield parseStack(e.error);
+    const stack = await parseStack(e.error);
     callback({
       type: "js",
       message: e.error.message,
       stack,
       throwable: e.error.stack || ""
     });
-  });
+  };
   window.addEventListener("error", handler);
   return () => window.removeEventListener("error", handler);
 }

package/dist/esm/capture/promiseError.js

@@ -1,35 +1,14 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
 // src/capture/promiseError.ts
 import { parseStack } from "../stack/stacktrace";
 import { logDebug } from "../utils/tools";
 function registerPromiseErrorCapture(debug, callback) {
   if (typeof window === "undefined")
     return void 0;
-  const handler = (e) => __async(this, null, function* () {
+  const handler = async (e) => {
     logDebug(debug, "registerPromiseErrorCapture unhandledrejection", e);
     const { reason } = e;
     if (reason instanceof Error) {
-      const stack = yield parseStack(reason);
+      const stack = await parseStack(reason);
       callback({
         type: "promise",
         message: reason.message,
@@ -37,7 +16,7 @@ function registerPromiseErrorCapture(debug, callback) {
         throwable: reason.stack || ""
       });
     }
-  });
+  };
   window.addEventListener("unhandledrejection", handler);
   return () => window.removeEventListener("unhandledrejection", handler);
 }

package/dist/esm/capture/wechatError.js

@@ -1,24 +1,3 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
 // src/capture/wechatError.ts
 import { parseStack } from "../stack/stacktrace";
 import { isWeChatMiniProgram } from "../utils/environment";
@@ -29,24 +8,23 @@ function registerWechatErrorCapture(debug, callback) {
   try {
     const wxAny = globalThis.wx;
     if (wxAny && typeof wxAny.onError === "function") {
-      const handler = (error) => __async(this, null, function* () {
-        var _a;
+      const handler = async (error) => {
         logDebug(debug, "registerWechatErrorCapture onError", error);
-        const msg = String((_a = error == null ? void 0 : error.message) != null ? _a : error);
+        const msg = String((error == null ? void 0 : error.message) ?? error);
         const err = error instanceof Error ? error : new Error(msg);
-        const stack = yield parseStack(err);
+        const stack = await parseStack(err);
         callback({
           type: "js",
           message: err.message,
           stack,
           throwable: err.stack || ""
         });
-      });
+      };
       wxAny.onError(handler);
       return () => {
         try {
           wxAny.offError && wxAny.offError(handler);
-        } catch (e) {
+        } catch {
         }
       };
     }
@@ -61,23 +39,23 @@ function registerWechatUnhandledCapture(debug, callback) {
   try {
     const wxAny = globalThis.wx;
     if (wxAny && typeof wxAny.onUnhandledRejection === "function") {
-      const handler = (res) => __async(this, null, function* () {
+      const handler = async (res) => {
         const reason = res == null ? void 0 : res.reason;
         logDebug(debug, "registerWechatUnhandledCapture onUnhandledRejection", reason);
         const err = reason instanceof Error ? reason : new Error(String(reason));
-        const stack = yield parseStack(err);
+        const stack = await parseStack(err);
         callback({
           type: "promise",
           message: err.message,
           stack,
           throwable: err.stack || ""
         });
-      });
+      };
       wxAny.onUnhandledRejection(handler);
       return () => {
         try {
           wxAny.offUnhandledRejection && wxAny.offUnhandledRejection(handler);
-        } catch (e) {
+        } catch {
         }
       };
     }

package/dist/esm/compress/compression.js

@@ -1,24 +1,3 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
 // src/compress/compression.ts
 import { gzipSync } from "fflate";
 import { isBrowser } from "../utils/environment";
@@ -39,31 +18,29 @@ function toUtf8Bytes(s) {
   }
   return new Uint8Array(out);
 }
-function gzipCompress(data) {
-  return __async(this, null, function* () {
-    if (isBrowser() && typeof CompressionStream !== "undefined") {
-      try {
-        const encoder = new TextEncoder();
-        const input = encoder.encode(data);
-        const gzip = new CompressionStream("gzip");
-        const readable = new Blob([input]).stream();
-        const compressedStream = readable.pipeThrough(gzip);
-        const compressedBuffer = yield new Response(compressedStream).arrayBuffer();
-        const bytes = new Uint8Array(compressedBuffer);
-        return convert2Base64FromArray(bytes);
-      } catch (e) {
-        console.log("gzipCompress 压缩失败，尝试使用 fflate 库", e);
-      }
-    }
+async function gzipCompress(data) {
+  if (isBrowser() && typeof CompressionStream !== "undefined") {
     try {
-      const input = toUtf8Bytes(data);
-      const compressed = gzipSync(input);
-      return convert2Base64FromArray(compressed);
+      const encoder = new TextEncoder();
+      const input = encoder.encode(data);
+      const gzip = new CompressionStream("gzip");
+      const readable = new Blob([input]).stream();
+      const compressedStream = readable.pipeThrough(gzip);
+      const compressedBuffer = await new Response(compressedStream).arrayBuffer();
+      const bytes = new Uint8Array(compressedBuffer);
+      return convert2Base64FromArray(bytes);
     } catch (e) {
-      console.log("gzipCompress 压缩失败", e);
+      console.log("gzipCompress 压缩失败，尝试使用 fflate 库", e);
     }
-    return data;
-  });
+  }
+  try {
+    const input = toUtf8Bytes(data);
+    const compressed = gzipSync(input);
+    return convert2Base64FromArray(compressed);
+  } catch (e) {
+    console.log("gzipCompress 压缩失败", e);
+  }
+  throw new Error("gzipCompress 不支持压缩");
 }
 function convert2Base64FromArray(data) {
   let binary = "";
@@ -78,16 +55,22 @@ function convert2Base64FromArray(data) {
   }
   throw new Error("convert2Base64FromArray 不支持转换");
 }
-function convert2Base64(data) {
+async function convert2Base64(data) {
   if (typeof btoa !== "undefined") {
     try {
       return btoa(data);
-    } catch (e) {
+    } catch {
     }
   }
   if (typeof Buffer !== "undefined") {
     return Buffer.from(data, "base64").toString("base64");
   }
+  try {
+    const mod = await import("js-base64");
+    return mod.Base64.encode(data);
+  } catch (e) {
+    console.log("convert2Base64 动态引入 js-base64 库失败", e);
+  }
   return data;
 }
 function isGzipSupported() {

package/dist/esm/core/httpClient.js

@@ -1,24 +1,3 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
 // src/core/httpClient.ts
 import { isWeChatMiniProgram } from "../utils/environment";
 import { logDebug } from "../utils/tools";
@@ -26,67 +5,65 @@ var HttpClient = class {
   /**
    * 发送 POST 请求,需要兼容浏览器和微信小程序
    */
-  static post(url, data, token) {
-    return __async(this, null, function* () {
-      logDebug(true, "post", url, data, token);
-      if (isWeChatMiniProgram()) {
-        return new Promise((resolve, reject) => {
-          wx.request({
-            url,
-            method: "POST",
-            data: JSON.stringify(data),
-            header: {
-              "Content-Type": "application/json",
-              Authorization: `Bearer ${token}`
-            },
-            success: (res) => resolve({
-              type: "wechat",
-              response: res
-            }),
-            fail: (err) => (
-              // eslint-disable-next-line prefer-promise-reject-errors
-              reject({
-                type: "wechat",
-                error: err
-              })
-            )
-          });
-        });
-      }
-      if (typeof fetch === "undefined") {
-        return new Promise((resolve, reject) => {
-          const xhr = new XMLHttpRequest();
-          xhr.open("POST", url, true);
-          xhr.setRequestHeader("Content-Type", "application/json");
-          xhr.setRequestHeader("Authorization", `Bearer ${token}`);
-          xhr.onreadystatechange = () => {
-            if (xhr.readyState === 4) {
-              if (xhr.status === 200) {
-                resolve({
-                  type: "xhr",
-                  response: xhr.responseText
-                });
-              } else {
-                reject({
-                  type: "xhr",
-                  error: new Error(xhr.statusText)
-                });
-              }
-            }
-          };
-          xhr.send(JSON.stringify(data));
-        });
-      }
+  static async post(url, data, token) {
+    logDebug(true, "post", url, data, token);
+    if (isWeChatMiniProgram()) {
       return new Promise((resolve, reject) => {
-        fetch(url, {
+        wx.request({
+          url,
           method: "POST",
-          body: JSON.stringify(data),
-          headers: {
+          data: JSON.stringify(data),
+          header: {
             "Content-Type": "application/json",
             Authorization: `Bearer ${token}`
+          },
+          success: (res) => resolve({
+            type: "wechat",
+            response: res
+          }),
+          fail: (err) => (
+            // eslint-disable-next-line prefer-promise-reject-errors
+            reject({
+              type: "wechat",
+              error: err
+            })
+          )
+        });
+      });
+    }
+    if (typeof fetch === "undefined") {
+      return new Promise((resolve, reject) => {
+        const xhr = new XMLHttpRequest();
+        xhr.open("POST", url, true);
+        xhr.setRequestHeader("Content-Type", "application/json");
+        xhr.setRequestHeader("Authorization", `Bearer ${token}`);
+        xhr.onreadystatechange = () => {
+          if (xhr.readyState === 4) {
+            if (xhr.status === 200) {
+              resolve({
+                type: "xhr",
+                response: xhr.responseText
+              });
+            } else {
+              reject({
+                type: "xhr",
+                error: new Error(xhr.statusText)
+              });
+            }
           }
-        }).then((res) => resolve({ type: "fetch", response: res })).catch((err) => reject({ type: "fetch", error: err }));
+        };
+        xhr.send(JSON.stringify(data));
       });
+    }
+    return new Promise((resolve, reject) => {
+      fetch(url, {
+        method: "POST",
+        body: JSON.stringify(data),
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${token}`
+        }
+      }).then((res) => resolve({ type: "fetch", response: res })).catch((err) => reject({ type: "fetch", error: err }));
     });
   }
 };