@be-link/cls-logger 1.0.1-beta.0

package/README.md

@@ -0,0 +1,30 @@
+# @be-link/cls-logger
+
+腾讯云 CLS（`tencentcloud-cls-sdk-js-web`）日志上报封装，参考仓库内 `@be-link/utils` 的构建方式（Rollup 打包 + tsc 仅产出 d.ts）。
+
+## 安装
+
+```bash
+pnpm add @be-link/cls-logger
+```
+
+## 使用
+
+```ts
+import clsLogger, { ClsLogger } from '@be-link/cls-logger';
+
+clsLogger.init({
+  topic_id: 'xxx',
+  projectName: 'my-project',
+  generateBaseFields: () => ({ env: 'prod', uid: 'u_1' }),
+});
+
+// 直接上报（展开字段）
+clsLogger.put({ event: 'login', ok: true });
+
+// 直接上报（JSON 放进单个 key，默认 “日志内容”）
+clsLogger.putJson({ event: 'click', x: 1, y: 2 });
+
+// 入队（写入 localStorage，默认 15 条自动 flush）
+clsLogger.enqueue({ event: 'page_view', page: '/home' });
+```

package/dist/ClsLogger.d.ts

@@ -0,0 +1,92 @@
+import { AsyncClient } from 'tencentcloud-cls-sdk-js-web';
+import type { ClsLoggerInitOptions, FlatFields, PutOptions, QueueItem, ReportLog } from './types';
+export declare class ClsLogger {
+    private client;
+    private topicId;
+    private endpoint;
+    private retryTimes;
+    private source;
+    private projectId;
+    private projectName;
+    private appId;
+    private appVersion;
+    private envType;
+    private userGenerateBaseFields;
+    private autoGenerateBaseFields;
+    private storageKey;
+    private batchSize;
+    private memoryQueue;
+    private batchMaxSize;
+    private batchIntervalMs;
+    private batchTimer;
+    private failedCacheKey;
+    private failedCacheMax;
+    private requestMonitorStarted;
+    private errorMonitorStarted;
+    private performanceMonitorStarted;
+    private behaviorMonitorStarted;
+    private behaviorMonitorCleanup;
+    init(options: ClsLoggerInitOptions): void;
+    private getBaseFields;
+    private startRequestMonitor;
+    private startErrorMonitor;
+    private startPerformanceMonitor;
+    private startBehaviorMonitor;
+    /**
+     * 停止行为埋点监听（PV/UV/点击）
+     * - 如需重启：可再次调用 init（或自行调用 init 后的默认启动逻辑）
+     */
+    stopBehaviorMonitor(): void;
+    getInstance(): AsyncClient;
+    private detectEnvType;
+    /**
+     * 直接上报：埋点入参必须是一维（扁平）Object
+     * - 非原始值（对象/数组等）会被自动 stringify 成 string
+     * - 最终会把 fields 展开成 CLS 的 content（key/value 都会转成 string）
+     */
+    put(fields: FlatFields, options?: PutOptions): void;
+    /**
+     * 直接上报：把 data 序列化后放入指定 key（默认 “日志内容”）
+     */
+    putJson(data: unknown, clsLoggerKey?: string, options?: PutOptions): void;
+    /**
+     * 入队：写入 localStorage 队列；达到 batchSize 自动 flush
+     * - 埋点入参必须是一维（扁平）Object，非原始值会被 stringify
+     */
+    enqueue(fields: FlatFields, options?: PutOptions): void;
+    /**
+     * 从 localStorage 读取队列并批量上报
+     */
+    flush(): void;
+    /**
+     * 批量上报（每条 item.data 展开为 log content）
+     */
+    putBatch(queue: QueueItem[]): void;
+    /**
+     * 参考《一、概述》：统一上报入口（内存队列 + 批量发送）
+     */
+    report(log: ReportLog): void;
+    info(message: string, data?: FlatFields): void;
+    warn(message: string, data?: FlatFields): void;
+    error(message: string, data?: FlatFields): void;
+    track(trackType: string, data?: FlatFields): void;
+    /**
+     * 立即发送内存队列
+     */
+    flushBatch(): Promise<void>;
+    private buildReportFields;
+    private sendReportLogs;
+    private retrySendReportLogs;
+    private cacheFailedReportLogs;
+    flushFailed(): void;
+    /**
+     * 统计/计数类日志：按字段展开上报（若 data 为空默认 1）
+     */
+    stat(param: {
+        pageName: string;
+        scene: string;
+        subScene: string;
+        data?: number | string;
+    }): void;
+}
+//# sourceMappingURL=ClsLogger.d.ts.map

package/dist/ClsLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClsLogger.d.ts","sourceRoot":"","sources":["../src/ClsLogger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiC,MAAM,6BAA6B,CAAC;AAEzF,OAAO,KAAK,EACV,oBAAoB,EAGpB,UAAU,EAEV,UAAU,EACV,SAAS,EACT,SAAS,EAEV,MAAM,SAAS,CAAC;AAiBjB,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAA4B;IAC1C,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,UAAU,CAAM;IACxB,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO,CAAC,SAAS,CAAM;IACvB,OAAO,CAAC,WAAW,CAAM;IACzB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,UAAU,CAAM;IACxB,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,sBAAsB,CAAmC;IACjE,OAAO,CAAC,sBAAsB,CAAmC;IACjE,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,SAAS,CAAM;IAGvB,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,eAAe,CAAO;IAC9B,OAAO,CAAC,UAAU,CAA8C;IAGhE,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,cAAc,CAAO;IAC7B,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,yBAAyB,CAAS;IAC1C,OAAO,CAAC,sBAAsB,CAAS;IACvC,OAAO,CAAC,sBAAsB,CAA6B;IAE3D,IAAI,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAgDzC,OAAO,CAAC,aAAa;IAwBrB,OAAO,CAAC,mBAAmB;IAsB3B,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,oBAAoB;IAuB5B;;;OAGG;IACH,mBAAmB,IAAI,IAAI;IAU3B,WAAW,IAAI,WAAW;IAS1B,OAAO,CAAC,aAAa;IAMrB;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,GAAE,UAAe,GAAG,IAAI;IAkCvD;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,SAAS,EAAE,OAAO,GAAE,UAAe,GAAG,IAAI;IAK7E;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,GAAE,UAAe,GAAG,IAAI;IA6B3D;;OAEG;IACH,KAAK,IAAI,IAAI;IAOb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI;IA0BlC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI;IAsB5B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAKlD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAKlD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IAKnD,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,IAAI;IASrD;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBjC,OAAO,CAAC,iBAAiB;YAmBX,cAAc;IAuB5B,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,qBAAqB;IAc7B,WAAW,IAAI,IAAI;IAkBnB;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI;CAcjG"}

package/dist/behaviorMonitor.d.ts

@@ -0,0 +1,5 @@
+import type { BehaviorMonitorOptions, EnvType, FlatFields } from './types';
+type ReportFn = (type: string, data: FlatFields) => void;
+export declare function installBehaviorMonitor(report: ReportFn, envType: EnvType, options?: BehaviorMonitorOptions): () => void;
+export {};
+//# sourceMappingURL=behaviorMonitor.d.ts.map

package/dist/behaviorMonitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"behaviorMonitor.d.ts","sourceRoot":"","sources":["../src/behaviorMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG3E,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;AA8FzD,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,sBAA2B,GACnC,MAAM,IAAI,CA4WZ"}

package/dist/deviceInfo.d.ts

@@ -0,0 +1,3 @@
+import type { DeviceInfoOptions, EnvType, FlatFields } from './types';
+export declare function createAutoDeviceInfoBaseFields(envType: EnvType, opts: boolean | DeviceInfoOptions | undefined): (() => FlatFields) | null;
+//# sourceMappingURL=deviceInfo.d.ts.map

package/dist/deviceInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceInfo.d.ts","sourceRoot":"","sources":["../src/deviceInfo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAwMtE,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,OAAO,GAAG,iBAAiB,GAAG,SAAS,GAC5C,CAAC,MAAM,UAAU,CAAC,GAAG,IAAI,CAyC3B"}

package/dist/errorMonitor.d.ts

@@ -0,0 +1,5 @@
+import type { ErrorMonitorOptions, FlatFields } from './types';
+type ReportFn = (type: string, data: FlatFields) => void;
+export declare function installErrorMonitor(report: ReportFn, opts?: boolean | ErrorMonitorOptions | undefined): void;
+export {};
+//# sourceMappingURL=errorMonitor.d.ts.map

package/dist/errorMonitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorMonitor.d.ts","sourceRoot":"","sources":["../src/errorMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG/D,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,CAAC;AA8MzD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,GAAE,OAAO,GAAG,mBAAmB,GAAG,SAAc,GAAG,IAAI,CAmBhH"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { ClsLogger } from './ClsLogger';
+export * from './types';
+export { ClsLogger } from './ClsLogger';
+export declare const clsLogger: ClsLogger;
+export default clsLogger;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,eAAO,MAAM,SAAS,WAAkB,CAAC;AACzC,eAAe,SAAS,CAAC"}