@pluve/mp-logger-sdk 0.0.1

package/dist/types/core/loggerSDK.d.ts

@@ -0,0 +1,87 @@
+import { Env } from '../types/env';
+import { SDKOptions } from '../types/sdkOptions';
+import { TrackOptions } from '../types/trackOptions';
+export declare class LoggerSDK {
+    private static instance;
+    private opts?;
+    /** 事件序列编号，用于事件去重 */
+    private seq;
+    /** 是否已关闭 */
+    private closed;
+    /** 预收集的环境信息 tags（仅用于初始化上报） */
+    private envTags;
+    /** 是否已初始化 */
+    private initialized;
+    /** 初始化时生成并锁定的会话标识 */
+    private sessionId;
+    /** 队列管理器 */
+    private queueManager?;
+    /** 重试管理器 */
+    private retryManager?;
+    private transporter?;
+    /** 批量上报定时器 */
+    private batchTimer?;
+    /** 是否正在上报 */
+    private isSending;
+    private collectSwitch;
+    private collectLogLevel;
+    private recentAutoEvents;
+    private offWxError?;
+    private offWxUnhandled?;
+    private constructor();
+    static getInstance(): LoggerSDK;
+    /**
+     * 初始化：配置参数、收集环境信息与 UA，并生成 sessionId，完成初始上报
+     */
+    init(options: SDKOptions): void;
+    /**
+     * 设置 token 信息
+     * @param token token
+     */
+    setToken(token: string): void;
+    /**
+     * 设置用户信息
+     */
+    identify(userId: string): void;
+    /** 设置店铺编码 */
+    setStoreCode(storeCode: string): void;
+    /** 设置日志 stage（env） */
+    setStage(stage: Env): void;
+    private flattenEnvTags;
+    track({ message, error, traceId, logLevel }: TrackOptions): Promise<void>;
+    private trackInner;
+    /**
+     * 判断是否应该发送事件
+     */
+    private shouldSend;
+    /**
+     * 记录事件
+     */
+    private doTrack;
+    /**
+     * 手动刷新队列，立即上报所有待发送日志
+     */
+    flush(): Promise<void>;
+    /**
+     * 销毁实例
+     */
+    destroy(): Promise<void>;
+    private generateToken;
+    /**
+     * 发送单个事件（带重试）
+     */
+    private sendEvent;
+    /**
+     * 批量发送事件（带重试）
+     */
+    private sendBatch;
+    /**
+     * 启动批量上报定时器
+     */
+    private startBatchTimer;
+    /**
+     * 初始化 SDK（注册/初始化）
+     */
+    private initSDK;
+}
+export default LoggerSDK;

package/dist/types/core/queueManager.d.ts

@@ -0,0 +1,55 @@
+import { LogEvent } from '../types/logEvent';
+/** 队列配置选项 */
+export interface QueueOptions {
+    /** 队列最大长度 */
+    maxSize: number;
+    /** 是否启用持久化存储 */
+    enableStorage: boolean;
+    /** 存储 key 前缀 */
+    storagePrefix: string;
+    /** 调试模式 */
+    debug?: boolean;
+}
+/**
+ * 队列管理器
+ * - 内存队列：快速访问
+ * - 持久化存储：防止页面刷新/关闭时数据丢失
+ */
+export declare class QueueManager {
+    private queue;
+    private opts;
+    private storageKey;
+    constructor(options: QueueOptions);
+    /**
+     * 添加日志到队列
+     */
+    enqueue(event: LogEvent): boolean;
+    /**
+     * 批量获取日志（不移除）
+     */
+    peek(count: number): LogEvent[];
+    /**
+     * 批量移除日志
+     */
+    dequeue(count: number): LogEvent[];
+    /**
+     * 获取队列长度
+     */
+    size(): number;
+    /**
+     * 清空队列
+     */
+    clear(): void;
+    /**
+     * 从持久化存储加载队列
+     */
+    private loadFromStorage;
+    /**
+     * 保存队列到持久化存储
+     */
+    private saveToStorage;
+    /**
+     * 从持久化存储移除队列
+     */
+    private removeFromStorage;
+}

package/dist/types/core/retryManager.d.ts

@@ -0,0 +1,53 @@
+/** 重试配置选项 */
+export interface RetryOptions {
+    /** 最大重试次数 */
+    maxRetries: number;
+    /** 基础延迟时间（毫秒） */
+    baseDelay: number;
+    /** 是否使用指数退避策略 */
+    useBackoff: boolean;
+    /** 调试模式 */
+    debug?: boolean;
+}
+/**
+ * 重试管理器
+ * - 支持自定义重试次数
+ * - 支持指数退避策略（exponential backoff）
+ * - 防止重复重试同一任务
+ */
+export declare class RetryManager {
+    private opts;
+    private retryingTasks;
+    constructor(options: RetryOptions);
+    /**
+     * 执行带重试的任务
+     * @param taskId - 任务唯一标识
+     * @param fn - 要执行的异步函数
+     * @returns Promise
+     */
+    executeWithRetry<T>(taskId: string, fn: () => Promise<T>): Promise<T>;
+    /**
+     * 执行任务（带重试逻辑）
+     */
+    private executeTask;
+    /**
+     * 计算延迟时间
+     * @param attempt - 当前重试次数
+     * @param baseDelay - 基础延迟时间
+     * @param useBackoff - 是否使用指数退避
+     * @returns 延迟时间（毫秒）
+     */
+    private static calculateDelay;
+    /**
+     * 睡眠函数
+     */
+    private static sleep;
+    /**
+     * 获取正在重试的任务数量
+     */
+    getRetryingCount(): number;
+    /**
+     * 清空所有重试任务
+     */
+    clear(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { LoggerSDK } from './core/loggerSDK';
+export type { Env, Stage } from './types/env';

package/dist/types/stack/stacktrace.d.ts

@@ -0,0 +1,2 @@
+import { StackFrame } from '../types/logEvent';
+export declare function parseStack(error: Error): Promise<StackFrame[]>;

package/dist/types/transport/beaconTransport.d.ts

@@ -0,0 +1,11 @@
+import { ReportData } from '../types/logEvent';
+import { Transporter, TransportOptions } from './transport';
+export declare class BeaconTransport implements Transporter {
+    /** 传输器名称 */
+    name: string;
+    /** 传输器名称 */
+    private opts?;
+    constructor(opts: TransportOptions);
+    isSupported(): boolean;
+    send(token: string, payload: ReportData): Promise<void>;
+}

package/dist/types/transport/pixelImageTransport.d.ts

@@ -0,0 +1,11 @@
+import { Transporter, TransportOptions } from './transport';
+import { ReportData } from '../types/logEvent';
+export declare class PixelImageTransport implements Transporter {
+    /** 传输器名称 */
+    name: string;
+    /** 传输器选项 */
+    private opts?;
+    constructor(opts: TransportOptions);
+    isSupported(): boolean;
+    send(token: string, payload: ReportData): Promise<void>;
+}

package/dist/types/transport/transport.d.ts

@@ -0,0 +1,14 @@
+import { ReportData } from '../types/logEvent';
+import { SDKOptions } from '../types/sdkOptions';
+/** 传输选项接口 */
+export interface TransportOptions extends SDKOptions {
+}
+/** 传输适配器接口 */
+export interface Transporter {
+    /** 适配器名称 */
+    name: string;
+    /** 是否支持当前环境 */
+    isSupported(): boolean;
+    /** 发送数据 */
+    send(token: string, payload: ReportData): Promise<void>;
+}

package/dist/types/transport/transportAdapter.d.ts

@@ -0,0 +1,8 @@
+import type { Transporter, TransportOptions } from './transport';
+export declare class TransportAdapter {
+    private static instance;
+    private opts;
+    private constructor();
+    static getInstance(opts: TransportOptions): TransportAdapter;
+    getTransporter(): Promise<Transporter>;
+}

package/dist/types/transport/wechatTransport.d.ts

@@ -0,0 +1,11 @@
+import { ReportData } from '../types/logEvent';
+import { Transporter, TransportOptions } from './transport';
+export declare class WechatTransport implements Transporter {
+    /** 传输器名称 */
+    name: string;
+    /** 传输器选项 */
+    private opts?;
+    constructor(opts: TransportOptions);
+    isSupported(): boolean;
+    send(token: string, payload: ReportData): Promise<void>;
+}

package/dist/types/types/api.d.ts

@@ -0,0 +1,12 @@
+export interface SDKInitData {
+    collectSwitch: number;
+    collectLogLevel: string[];
+    samplingRate: number;
+}
+export interface APIResponse<T> {
+    code: number;
+    message?: string;
+    data: T;
+    timestamp: string;
+    traceId: string;
+}

package/dist/types/types/env.d.ts

@@ -0,0 +1,14 @@
+/** 环境类型 */
+export type Env = 'develop' | 'testing' | 'product';
+export type Stage = 'develop' | 'testing' | 'sit' | 'yace' | 'product';
+/** 平台类型 */
+export type PlatformType = 'browser' | 'wechat' | 'unknown';
+/** 环境信息 */
+export interface EnvironmentInfo {
+    platform: PlatformType;
+    userAgent?: string;
+    screenWidth?: number;
+    screenHeight?: number;
+    language?: string;
+    systemInfo?: any;
+}

package/dist/types/types/logEvent.d.ts

@@ -0,0 +1,57 @@
+import { Stage } from './env';
+import { LogEventLevel } from './logEventLevel';
+/** 标准化日志上报格式 */
+export interface LogEvent {
+    /** 日志 ID */
+    logId: string;
+    /** 事件序列编号（去重/排序辅助） */
+    seq: number;
+    /** 应用标识 */
+    appId: string;
+    /** 环境标识 */
+    stage: Stage;
+    /** 日志级别：info/warn/error/fatal */
+    level: LogEventLevel;
+    /** 可选：跟踪 ID（跨服务调用链跟踪） */
+    traceId?: string;
+    /** 会话标识，同 sessionId */
+    frontendId: string;
+    /** 发生页面 URL */
+    url?: string;
+    location: string;
+    /** 异常信息 */
+    message: string;
+    /** 可选：堆栈信息（长字符串） */
+    throwable?: string;
+    /** 可选：用户 ID（脱敏） */
+    userId?: string;
+    /** 可选：店铺编码 */
+    storeCode?: string;
+    /** 可选的结构化额外信息 */
+    tags?: Record<string, any>;
+}
+export interface StackFrame {
+    file: string;
+    line: number;
+    column: number;
+    function?: string;
+}
+export type BaseErrorInfo = {
+    type: 'js' | 'promise' | 'resource';
+    message: string;
+    stack: StackFrame[];
+    throwable?: string;
+};
+export type ReportData = {
+    appId: string;
+    appStage: Stage;
+    items: ReportItem[];
+};
+export type ReportItem = {
+    level: LogEventLevel;
+    traceId?: string;
+    frontendId: string;
+    location: string;
+    message: string;
+    throwable?: string;
+};

package/dist/types/types/logEventLevel.d.ts

@@ -0,0 +1,2 @@
+/** 日志级别 */
+export type LogEventLevel = 'INFO' | 'WARN' | 'ERROR' | 'FATAL';

package/dist/types/types/sdkOptions.d.ts

@@ -0,0 +1,61 @@
+import { Env, Stage } from './env';
+import { LogEventLevel } from './logEventLevel';
+/** SDK 配置选项 */
+export interface SDKOptions {
+    /** 上报端点 URL */
+    /** 应用 ID */
+    appId: string;
+    /** 环境标识 */
+    env?: Env;
+    /** 日志环境 */
+    logStage: Stage;
+    /** 是否开启调试模式 */
+    debug?: boolean;
+    /** 是否启用批量上报，默认 true */
+    enableBatch?: boolean;
+    /** 批量上报最大数量，默认 10 */
+    batchSize?: number;
+    /** 是否启用 gzip 压缩，默认 true (仅在批量模式下有效) */
+    enableGzip?: boolean;
+    /** 批量模式下启用 gzip 压缩的最小 items 数量，默认 2 */
+    gzipBatchMinSize?: number;
+    /** 最大像素图 URL 长度，默认 1900 */
+    maxPixelUrlLen?: number;
+    /** 批量上报时间间隔（毫秒），默认 5000 */
+    batchInterval?: number;
+    /** 队列最大长度，默认 100 */
+    maxQueueSize?: number;
+    /** 是否启用持久化存储，默认 true */
+    enableStorage?: boolean;
+    /** 持久化存储的 key 前缀，默认 'logger_sdk' */
+    storagePrefix?: string;
+    /** 是否启用重试，默认 true */
+    enableRetry?: boolean;
+    /** 最大重试次数，默认 3 */
+    maxRetries?: number;
+    /** 重试基础延迟时间（毫秒），默认 1000 */
+    retryDelay?: number;
+    /** 是否使用指数退避策略，默认 true */
+    retryBackoff?: boolean;
+    /** 可选：用户 ID（脱敏） */
+    userId?: string;
+    /** 可选：店铺编码 */
+    storeCode?: string;
+    /** token */
+    token: string;
+    /** 全局采样率 0.0-1.0，默认 1.0（全量） */
+    sampleRate?: number;
+    /** 分级采样率，优先于全局采样率 */
+    levelSampleRate?: Partial<Record<LogEventLevel, number>>;
+    /** 事件来源采样率（js/promise/resource/custom），优先于全局采样率 */
+    sourceSampleRate?: Partial<Record<'js' | 'promise' | 'resource' | 'custom', number>>;
+    /** 页面路径采样率，key 为路径前缀，优先于全局采样率 */
+    pathSampleRate?: Record<string, number>;
+    autoCapture?: {
+        js?: boolean;
+        promise?: boolean;
+        resource?: boolean;
+        wechat?: boolean;
+    };
+    enableAutoCapture?: boolean;
+}

package/dist/types/types/securityType.d.ts

@@ -0,0 +1,6 @@
+export declare const SecurityType: {
+    ACCOUNT_CENTER: string;
+    EHP: string;
+    CUSTOMER: string;
+    BASE: string;
+};

package/dist/types/types/trackOptions.d.ts

@@ -0,0 +1,7 @@
+import { LogEventLevel } from './logEventLevel';
+export type TrackOptions = {
+    message: string;
+    error?: Error | unknown;
+    traceId?: string;
+    logLevel?: LogEventLevel;
+};

package/dist/types/utils/environment.d.ts

@@ -0,0 +1,10 @@
+import { EnvironmentInfo } from '../types/env';
+export declare function getCurrentUrl(): string;
+/**
+ * 获取环境信息
+ */
+export declare function getEnvironmentInfo(): EnvironmentInfo;
+/**
+ * 收集环境信息并生成 tags（仅在初始化时执行一次）
+ */
+export declare function collectEnvironmentTags(): Record<string, string | number | boolean | undefined>;

package/dist/types/utils/innerMD5.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Minimal MD5 implementation
+ * @param input Input string
+ * @returns MD5 hash string (hex)
+ */
+export declare const md5: (input: string) => string;

package/dist/types/utils/session.d.ts

@@ -0,0 +1 @@
+export declare function getSessionId(): string;

package/dist/types/utils/tools.d.ts

@@ -0,0 +1,12 @@
+export declare const now: () => number;
+export declare function safeStringify(obj: any): string;
+export declare function normalizeMessage(message: string): string;
+export declare function logDebug(debug: boolean, ...args: any[]): void;
+/**
+ * 计算哈希值到概率
+ */
+export declare function hashToProb(s: string): number;
+export declare function flattenStack(error: Error): Promise<{
+    location: string;
+    throwable: string;
+}>;

package/dist/types/utils/uuid.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 生成 UUID v4
+ * 符合 RFC 4122 标准
+ * 格式: xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx
+ * 其中 x 是 0-f 的十六进制数字,y 是 8/9/a/b 之一
+ */
+export declare function uuid(): string;

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@pluve/mp-logger-sdk",
+  "version": "0.0.1",
+  "description": "mini program logger sdk",
+  "keywords": [
+    "logger"
+  ],
+  "author": "黄震 <huangzhen@yfpharmacy.com>",
+  "homepage": "http://.",
+  "license": "ISC",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "browser": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "index": ["dist/types/index.d.ts"],
+      "*": ["dist/types/*"]
+    }
+  },
+  "directories": {
+    "dist": "dist",
+    "types": "dist/types"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.pharmacyyf.com/frontend-common/pluve-lib.git"
+  },
+  "scripts": {
+    "init-install": "pnpm install",
+    "build-types": "tsc -p tsconfig.types.json",
+    "typecheck": "tsc -p tsconfig.json",
+    "build": "pnpm run build-types && father build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "clear-types": "rm -rf lib",
+    "clear-build": "rm -rf dist",
+    "clear-node_modules": "rm -rf node_modules",
+    "generate-mermaid": "mermaid-cli logger-sdk.mermaid -o logger-sdk.svg"
+  },
+  "devDependencies": {
+    "vitest": "^4.0.15"
+  },
+  "dependencies": {
+    "fflate": "^0.8.2"
+  },
+  "peerDependencies": {
+  }
+}