easemob-uniapp-logger-plugin 1.4.4

package/dist/lib/logger.d.ts

@@ -0,0 +1,216 @@
+/**
+ * UniApp 日志收集插件
+ * 支持传入 SDK 实例自动获取配置，简化使用
+ */
+/** SDK 连接实例接口 */
+export interface SDKConnection {
+    /** API 地址（优先使用） */
+    apiUrl?: string;
+    /** API 地址（兼容下划线命名） */
+    api_url?: string;
+    /** REST API 地址（某些 SDK 版本使用） */
+    restUrl?: string;
+    /** SDK 版本 */
+    version?: string;
+    /** 当前用户 */
+    user?: string;
+    /** 连接上下文 */
+    context?: {
+        /** 访问令牌 */
+        accessToken?: string;
+        /** AppKey */
+        appKey?: string;
+    };
+    /** 请求方法（用于兼容不同 SDK 版本） */
+    request?: (options: {
+        url: string;
+        data?: any;
+        method?: string;
+        headers?: Record<string, string>;
+    }) => Promise<any>;
+}
+export type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'FATAL';
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    timestamp: number;
+    data?: any;
+}
+export interface LoggerConfig {
+    /** 日志文件过期天数，0表示不清理 */
+    expireDays: number;
+    /** 单个日志文件最大大小 (bytes)，默认2MB */
+    maxFileSize: number;
+    /** 日志根目录名 */
+    rootDirectory: string;
+    /** 日志目录名 */
+    directory: string;
+    /** 日志文件名 */
+    fileName: string;
+    /** 批量写入间隔 (ms) */
+    flushInterval: number;
+    /** 批量写入数量阈值 */
+    batchSize: number;
+    /** 上传超时时间 (ms)，默认30秒 */
+    uploadTimeout: number;
+    /** 最大保留日志文件数，默认3个（用于日志滚动） */
+    maxFiles: number;
+}
+/** 自定义上传处理器 */
+export type CustomUploadHandler = (logContent: string) => Promise<void> | void;
+/** 自定义上传配置 */
+export interface CustomUploadConfig {
+    /** 自定义上传 URL（如果不传，使用环信默认上传） */
+    url?: string;
+    /** 自定义上报 URL（如果不传，使用环信默认上报） */
+    reportUrl?: string;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 自定义上传处理器（优先级高于 URL） */
+    handler?: CustomUploadHandler;
+}
+export interface LoggerOptions {
+    /** SDK 连接实例（传入后自动从中获取 token/user/appKey 等） */
+    conn?: SDKConnection;
+    /** 日志配置 */
+    log?: Partial<LoggerConfig>;
+    /** 自定义上传配置（不传则使用环信默认上传） */
+    customUpload?: CustomUploadConfig;
+}
+/** SDK 日志数据格式（用于 websdk.logger.onLog） */
+export interface SDKLogData {
+    /** 时间字符串，如 "13:42:55:168" */
+    time: string;
+    /** 日志级别 */
+    level: 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+    /** 日志内容数组，第一个是消息，后面是参数 */
+    logs: unknown[];
+}
+/** SDK 消息对象（CMD 消息等） */
+export interface SDKMessage {
+    /** 消息 ID */
+    id: string;
+    /** 消息类型 */
+    type: string;
+    /** 聊天类型 */
+    chatType?: string;
+    /** 发送者 */
+    from?: string;
+    /** 接收者 */
+    to?: string;
+    /** CMD 动作 */
+    action?: string;
+    /** 扩展字段 */
+    ext?: Record<string, unknown>;
+    /** 时间戳 */
+    time?: number;
+    /** 在线状态 */
+    onlineState?: number;
+    /** 消息配置 */
+    msgConfig?: Record<string, unknown>;
+}
+/** 设备信息 */
+export interface DeviceInfo {
+    deviceBrand?: string;
+    deviceModel?: string;
+    platform?: string;
+    system?: string;
+}
+/**
+ * 隐藏 appkey 中的敏感信息
+ */
+export declare function maskAppkey(appkey: string, maskChar?: string): string;
+declare class Logger {
+    private config;
+    private storage;
+    private initialized;
+    private minLevel;
+    /** SDK 连接实例 */
+    private conn;
+    /** 自定义上传配置 */
+    private customUpload?;
+    /** 标记是否处于上传流程中，防止上传失败写日志导致循环 */
+    private isInUploadProcess;
+    constructor();
+    /**
+     * 初始化日志器
+     * @param options - 配置选项，可以传入 SDK 实例自动获取配置
+     */
+    init(options?: LoggerOptions): void;
+    /**
+     * 获取 SDK 相关配置
+     * 注意：每次调用都实时读取 conn 中的最新值
+     */
+    private getSDKConfig;
+    /**
+     * 设置最小日志级别
+     */
+    setMinLevel(level: LogLevel): void;
+    private shouldLog;
+    log(level: LogLevel, message: string, data?: unknown): void;
+    debug(message: string, data?: unknown): void;
+    info(message: string, data?: unknown): void;
+    warn(message: string, data?: unknown): void;
+    error(message: string, data?: unknown): void;
+    fatal(message: string, data?: unknown): void;
+    /**
+     * 处理来自 SDK 的日志数据
+     * 适配 websdk.logger.onLog 的格式
+     * @param data - SDK 日志数据 { time, level, logs }
+     *
+     * @example
+     * websdk.logger.onLog = (data) => {
+     *   logger.handleSDKLog(data);
+     * };
+     */
+    handleSDKLog(data: SDKLogData): void;
+    /**
+     * 处理 CMD 消息，检测是否为上传日志指令
+     * 收到指令后立即 flush 缓存并上传
+     * @param message - SDK 消息对象
+     */
+    private handleCmdMessage;
+    /**
+     * 立即刷新所有待写入的日志到文件
+     */
+    flush(): Promise<void>;
+    private consoleOutput;
+    read(): Promise<string>;
+    getFilePath(): string;
+    clear(): Promise<void>;
+    compress(targetPath?: string): Promise<string | null>;
+    removeFile(path: string): Promise<void>;
+    /**
+     * 上传日志文件
+     * 支持多种上传方式：
+     * 1. 传入自定义 handler 时使用自定义上传
+     * 2. 传入自定义 URL 时使用自定义 URL
+     * 3. 默认使用环信 SDK 上传（需要传入 conn）
+     *
+     * @param options - 可选的自定义上传配置（覆盖初始化时的配置）
+     */
+    upload(options?: CustomUploadConfig): Promise<void>;
+    /**
+     * 实际执行上传的内部方法
+     */
+    private doUpload;
+    /**
+     * 上报 UUID 到服务器
+     * 使用与上传时一致的 token，避免 token 变化导致的不一致
+     */
+    private reportUUID;
+    /**
+     * 主动触发上传到自定义地址
+     * @param url - 上传地址
+     * @param headers - 请求头
+     */
+    uploadTo(url: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * 使用自定义处理器上传
+     * @param handler - 自定义上传处理器
+     */
+    uploadWithHandler(handler: CustomUploadHandler): Promise<void>;
+    destroy(): void;
+}
+export declare const logger: Logger;
+export default logger;

package/dist/main.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Easemob UniApp Logger Plugin
+ *
+ * 一个适用于 uni-app 应用的高性能日志收集工具类库
+ * 支持传入 SDK 实例自动获取配置
+ *
+ * 使用示例：
+ * ```typescript
+ * import { logger } from 'easemob-uniapp-logger-plugin';
+ * import { conn } from 'easemob-websdk';
+ *
+ * // 方式1：传入 SDK 实例，自动获取配置
+ * logger.init({ conn });
+ *
+ * // 方式2：自定义上传
+ * logger.init({
+ *   conn,
+ *   customUpload: {
+ *     url: 'https://your-server.com/upload',
+ *     reportUrl: 'https://your-server.com/report'
+ *   }
+ * });
+ *
+ * // 方式3：使用自定义 handler
+ * logger.init({
+ *   customUpload: {
+ *     handler: async (logContent) => {
+ *       console.log('Upload logs:', logContent);
+ *     }
+ *   }
+ * });
+ * ```
+ */
+export { logger, maskAppkey } from './lib/logger';
+export type { SDKConnection, SDKLogData, SDKMessage, LogLevel, LogEntry, DeviceInfo, LoggerConfig, CustomUploadHandler, CustomUploadConfig, LoggerOptions } from './lib/logger';
+export { logger as default } from './lib/logger';

package/dist/types/index.d.ts

@@ -0,0 +1,85 @@
+/**
+ * UniApp 日志收集插件类型定义
+ */
+/** SDK 连接实例接口 */
+export interface SDKConnection {
+    /** API 地址 */
+    apiUrl?: string;
+    /** SDK 版本 */
+    version?: string;
+    /** 当前用户 */
+    user?: string;
+    /** 连接上下文 */
+    context?: {
+        /** 访问令牌 */
+        accessToken?: string;
+        /** AppKey */
+        appKey?: string;
+    };
+    /** 请求方法（用于兼容不同 SDK 版本） */
+    request?: (options: {
+        url: string;
+        data?: any;
+        method?: string;
+        headers?: Record<string, string>;
+    }) => Promise<any>;
+}
+/** 日志级别 */
+export type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'FATAL';
+/** 日志条目 */
+export interface LogEntry {
+    level: LogLevel;
+    message: string;
+    timestamp: number;
+    data?: any;
+}
+/** 设备信息 */
+export interface DeviceInfo {
+    /** 设备品牌 */
+    deviceBrand?: string;
+    /** 设备型号 */
+    deviceModel?: string;
+    /** 平台 */
+    platform?: string;
+    /** 系统版本 */
+    system?: string;
+}
+/** 日志配置 */
+export interface LoggerConfig {
+    /** 日志文件过期天数，0表示不清理 */
+    expireDays: number;
+    /** 单个日志文件最大大小 (bytes)，默认2MB */
+    maxFileSize: number;
+    /** 日志根目录名 */
+    rootDirectory: string;
+    /** 日志目录名 */
+    directory: string;
+    /** 日志文件名 */
+    fileName: string;
+    /** 批量写入间隔 (ms) */
+    flushInterval: number;
+    /** 批量写入数量阈值 */
+    batchSize: number;
+}
+/** 自定义上传处理器 */
+export type CustomUploadHandler = (logContent: string) => Promise<void> | void;
+/** 自定义上传配置 */
+export interface CustomUploadConfig {
+    /** 自定义上传 URL（如果不传，使用环信默认上传） */
+    url?: string;
+    /** 自定义上报 URL（如果不传，使用环信默认上报） */
+    reportUrl?: string;
+    /** 自定义请求头 */
+    headers?: Record<string, string>;
+    /** 自定义上传处理器（优先级高于 URL） */
+    handler?: CustomUploadHandler;
+}
+/** Logger 选项 */
+export interface LoggerOptions {
+    /** SDK 连接实例（传入后自动从中获取 token/user/appKey 等） */
+    conn?: SDKConnection;
+    /** 日志配置 */
+    log?: Partial<LoggerConfig>;
+    /** 自定义上传配置（不传则使用环信默认上传） */
+    customUpload?: CustomUploadConfig;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "easemob-uniapp-logger-plugin",
+  "private": false,
+  "version": "1.4.4",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && npm run build:types && npm run build:copy",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir dist",
+    "build:copy": "cp dist/index.js dist/easemob-uniapp-logger.esm.js",
+    "preview": "vite preview",
+    "type-check": "tsc"
+  },
+  "keywords": [
+    "uniapp",
+    "logger",
+    "easemob",
+    "log",
+    "plugin"
+  ],
+  "description": "A logger plugin for uniapp applications",
+  "author": "",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Easemob-Community/easemob-uniapp-logger-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Easemob-Community/easemob-uniapp-logger-plugin/issues"
+  },
+  "homepage": "https://github.com/Easemob-Community/easemob-uniapp-logger-plugin#readme",
+  "devDependencies": {
+    "@dcloudio/types": "^3.4.28",
+    "javascript-obfuscator": "^5.3.0",
+    "rollup-plugin-obfuscator": "^1.1.0",
+    "typescript": "~5.9.3",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.1"
+  }
+}