@haluo/util 2.0.33 → 2.1.0

package/dist/modules/track/index.js

@@ -0,0 +1,368 @@
+/**
+ * Track 埋点模块
+ * 统一封装各项目的埋点上报逻辑
+ *
+ * @example
+ * // 最简初始化（所有配置都有默认值）
+ * import { createTracker } from '@haluo/util/dist/modules/track'
+ *
+ * const tracker = createTracker({})
+ * // 或指定 appName
+ * const tracker2 = createTracker({ appName: 'emoto' })
+ *
+ * // 使用
+ * tracker.track('EVENT_ID', { key: 'value' })
+ * tracker.trackError({ err: 'error message' })
+ */
+export * from './types';
+/** 默认埋点上报URL */
+const DEFAULT_LOG_URL = 'https://log-center.58moto.com/am/log/v1/json';
+/** 默认应用名称 */
+const DEFAULT_APP_NAME = 'moto';
+/** 默认错误上报事件ID */
+const ERROR_EVENT_ID = 'S_00000000000082';
+/** 默认错误应用类型（H5异常） */
+const DEFAULT_ERROR_APPTYPE = '2012';
+/**
+ * 内置的简易 httpClient
+ * 使用 fetch 实现 POST 请求
+ */
+const defaultHttpClient = {
+    post: (url, data) => {
+        if (typeof window === 'undefined' || !window.fetch) {
+            console.warn('[Tracker] 当前环境不支持 fetch');
+            return Promise.resolve();
+        }
+        // 构建 form-urlencoded 格式的请求体
+        const formBody = Object.keys(data)
+            .map(key => encodeURIComponent(key) + '=' + encodeURIComponent(data[key]))
+            .join('&');
+        return fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded'
+            },
+            body: formBody
+        }).then(res => res.json()).catch(err => {
+            console.error('[Tracker] 埋点请求失败:', err);
+        });
+    }
+};
+/**
+ * 从 localStorage 安全获取并解析 JSON
+ */
+function safeGetLocalStorage(key, defaultValue) {
+    try {
+        if (typeof window === 'undefined' || !window.localStorage) {
+            return defaultValue;
+        }
+        const value = window.localStorage.getItem(key);
+        if (!value || value === 'undefined') {
+            return defaultValue;
+        }
+        return JSON.parse(value);
+    }
+    catch {
+        return defaultValue;
+    }
+}
+/**
+ * 获取用户代理字符串
+ */
+function getUserAgent() {
+    if (typeof window === 'undefined' || !window.navigator) {
+        return '';
+    }
+    return window.navigator.userAgent.toLowerCase();
+}
+/**
+ * 检测平台类型
+ */
+function detectPlatform(ua) {
+    const isAndroid = ua.indexOf('android') > -1;
+    const isHarmonyos = ua.indexOf('harmonyos') > -1;
+    return isAndroid || isHarmonyos ? 'android' : 'ios';
+}
+/**
+ * 检测是否在客户端环境
+ */
+function isClientEnv() {
+    return typeof window !== 'undefined' && !!window.isClient;
+}
+/**
+ * 检测是否为开发环境
+ */
+function isDevelopment() {
+    return process.env.NODE_ENV === 'development';
+}
+/**
+ * 获取全局 AppCall 对象
+ */
+function getGlobalAppCall() {
+    if (typeof window === 'undefined')
+        return null;
+    return window.AppCall || null;
+}
+/**
+ * 内置的 getChannel 方法
+ * 根据 UA 检测渠道：微信、QQ、微博等
+ */
+function defaultGetChannel() {
+    if (typeof window === 'undefined' || !window.navigator) {
+        return 'other';
+    }
+    const ua = window.navigator.userAgent.toLowerCase();
+    const isAndroid = ua.indexOf('android') > -1;
+    // 区分出微信、QQ、微博平台、其他
+    if (ua.indexOf('micromessenger') > -1) {
+        // 在微信中打开
+        return 'weixin';
+    }
+    else if (ua.indexOf('weibo') > -1) {
+        // 在新浪微博客户端打开
+        return 'weibo';
+    }
+    else if (ua.indexOf(' qq') > -1 && ua.indexOf('mqqbrowser') < 0 && !isAndroid) {
+        // ios在QQ空间打开
+        return 'qq';
+    }
+    else if (ua.indexOf(' qq') > -1 && ua.indexOf('mqqbrowser') > -1 && isAndroid) {
+        // 安卓在QQ空间打开
+        return 'qq';
+    }
+    else {
+        // 使用 AppCall 获取包名，或返回 other
+        const appCall = getGlobalAppCall();
+        return appCall?.getAppPackage?.() || 'other';
+    }
+}
+/**
+ * Track 类
+ * 提供埋点上报功能
+ */
+class Tracker {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * 获取当前版本号
+     * 优先级：window.AppCall.getAppVersion() > 传入的 appCall > config.version
+     */
+    getVersion() {
+        const { version, appCall } = this.config;
+        // 优先使用全局 window.AppCall 获取版本号
+        const globalAppCall = getGlobalAppCall();
+        if (globalAppCall?.getAppVersion) {
+            const appVersion = globalAppCall.getAppVersion();
+            if (appVersion)
+                return appVersion;
+        }
+        // 其次使用传入的 appCall
+        if (appCall?.getAppVersion) {
+            const appVersion = appCall.getAppVersion();
+            if (appVersion)
+                return appVersion;
+        }
+        return version || '';
+    }
+    /**
+     * 获取渠道号
+     * 优先使用自定义 getChannel，否则使用内置的默认方法
+     */
+    getChannel() {
+        if (this.config.getChannel) {
+            return this.config.getChannel();
+        }
+        // 使用内置的 getChannel 方法
+        return defaultGetChannel();
+    }
+    /**
+     * 检查是否命中AB测试
+     */
+    checkAbTest(eId) {
+        if (!this.config.enableAbTest || !this.config.getAbFlags) {
+            return undefined;
+        }
+        try {
+            const abFlags = this.config.getAbFlags();
+            // 支持数组和对象两种格式
+            const flagList = Array.isArray(abFlags) ? abFlags : Object.values(abFlags);
+            return flagList.find(item => item?.indexList?.includes(eId));
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * 构建埋点请求数据
+     */
+    buildPostData(params) {
+        const { eId, eventContent } = params;
+        const deviceData = safeGetLocalStorage('deviceData', {});
+        const userData = safeGetLocalStorage('user', {});
+        const ua = getUserAgent();
+        const platform = detectPlatform(ua);
+        const isClient = isClientEnv();
+        return {
+            deviceid: deviceData.deviceId || '',
+            plateform: isClient ? platform : 'h5',
+            subplateform: 'h5',
+            version: this.getVersion(),
+            channel: this.getChannel(),
+            client: '',
+            os: '',
+            useragent: ua,
+            logs: [
+                {
+                    uid: String(userData.uid || '0'),
+                    eventid: eId,
+                    eventcontent: eventContent || '{}',
+                    begintime: Date.now(),
+                    pmenu: '',
+                    menu: '',
+                    net: deviceData.network || '',
+                    lon: '',
+                    lat: '',
+                    areacode: '',
+                    address: ''
+                }
+            ]
+        };
+    }
+    /**
+     * 发送埋点请求
+     */
+    sendRequest(postData) {
+        const logUrl = this.config.logUrl || DEFAULT_LOG_URL;
+        const appName = this.config.appName || DEFAULT_APP_NAME;
+        // 优先使用传入的 httpClient，否则使用内置的默认实现
+        const httpClient = this.config.httpClient || defaultHttpClient;
+        return httpClient.post(logUrl, {
+            json: JSON.stringify(postData),
+            appName
+        });
+    }
+    /**
+     * 核心埋点方法
+     * @param params 埋点参数
+     */
+    async trackUser(params) {
+        const { eId, eventContent } = params;
+        // 开发环境不发送埋点
+        if (isDevelopment()) {
+            console.log('[Tracker] 开发环境，跳过埋点:', { eId, eventContent });
+            return Promise.resolve();
+        }
+        // 检查AB测试
+        if (this.config.enableAbTest) {
+            const abFlag = this.checkAbTest(eId);
+            if (abFlag?.test) {
+                // 优先使用全局 window.AppCall，其次使用传入的 appCall
+                const globalAppCall = getGlobalAppCall();
+                const appCall = globalAppCall || this.config.appCall;
+                if (appCall?.sendEventMsg) {
+                    return appCall.sendEventMsg({ eId, eventContent: eventContent || '{}' });
+                }
+            }
+        }
+        // 构建并发送请求
+        const postData = this.buildPostData(params);
+        return this.sendRequest(postData);
+    }
+    /**
+     * 埋点上报
+     * @param eId 事件ID
+     * @param contentObj 事件内容对象
+     * @param isAbTest 是否AB测试（已废弃，保留兼容）
+     */
+    track(eId, contentObj = {}, isAbTest = false) {
+        return this.trackUser({
+            eId,
+            eventContent: JSON.stringify(contentObj),
+            isAbTest
+        });
+    }
+    /**
+     * 错误上报
+     * @param contentObj 错误内容对象
+     */
+    trackError(contentObj = {}) {
+        const errorContent = {
+            err: contentObj.err || '',
+            apptype: contentObj.apptype || DEFAULT_ERROR_APPTYPE,
+            url: contentObj.url || (typeof window !== 'undefined' ? window.location?.href : '') || '',
+            platform: contentObj.platform || 'wap',
+            ...contentObj
+        };
+        return this.trackUser({
+            eId: ERROR_EVENT_ID,
+            eventContent: JSON.stringify(errorContent)
+        });
+    }
+    /**
+     * 更新配置
+     */
+    updateConfig(config) {
+        this.config = { ...this.config, ...config };
+    }
+    /**
+     * 获取当前配置
+     */
+    getConfig() {
+        return { ...this.config };
+    }
+}
+/**
+ * 创建 Tracker 实例
+ * @param config 配置项
+ * @returns Tracker 实例
+ *
+ * @example
+ * const tracker = createTracker({
+ *   appName: 'emoto'
+ *   // logUrl 可选，默认: https://log-center.58moto.com/am/log/v1/json
+ *   // httpClient 可选，默认使用内置 fetch 实现
+ * })
+ *
+ * // 普通埋点
+ * tracker.track('EVENT_001', { page: 'home' })
+ *
+ * // 错误上报
+ * tracker.trackError({ err: 'Something went wrong' })
+ */
+export function createTracker(config) {
+    return new Tracker(config);
+}
+/**
+ * 创建简化版埋点方法
+ * 返回 postTrack 和 postTrackError 方法，与原有项目用法一致
+ *
+ * @example
+ * const { postTrack, postTrackError } = createTrackMethods({
+ *   appName: 'moto'
+ * })
+ *
+ * // 等同于原来的 postJddTrack
+ * postTrack('EVENT_001', { page: 'home' })
+ *
+ * // 等同于原来的 postJddTrackError
+ * postTrackError({ err: 'error message' })
+ */
+export function createTrackMethods(config) {
+    const tracker = createTracker(config);
+    return {
+        /** 埋点上报方法 */
+        postTrack: (eId, contentObj = {}, isAbTest = false) => {
+            return tracker.track(eId, contentObj, isAbTest);
+        },
+        /** 错误上报方法 */
+        postTrackError: (contentObj = {}) => {
+            return tracker.trackError(contentObj);
+        },
+        /** Tracker 实例 */
+        tracker
+    };
+}
+export { defaultGetChannel as getChannel };
+export default createTracker;

package/dist/modules/track/types.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Track 模块类型定义
+ */
+/** 应用名称类型 */
+export type AppName = 'emoto' | 'moto' | 'watch' | 'drone' | string;
+/** 平台类型 */
+export type Platform = 'android' | 'ios' | 'h5' | 'wap';
+/** Track 初始化配置 */
+export interface TrackConfig {
+    /** 应用名称，如 'emoto', 'moto', 'watch'，默认: 'moto' */
+    appName?: AppName;
+    /** 埋点上报URL，默认: https://log-center.58moto.com/am/log/v1/json */
+    logUrl?: string;
+    /** 应用版本号 */
+    version?: string;
+    /** HTTP请求方法，需要支持 post(url, data) 形式 */
+    httpClient?: HttpClient;
+    /** 获取渠道号的方法 */
+    getChannel?: () => string;
+    /** AppCall实例（用于AB测试等场景） */
+    appCall?: AppCallInterface;
+    /** 是否启用AB测试逻辑 */
+    enableAbTest?: boolean;
+    /** 获取当前AB测试标记的方法 */
+    getAbFlags?: () => AbFlag[] | Record<string, AbFlag>;
+}
+/** HTTP客户端接口 */
+export interface HttpClient {
+    post: (url: string, data: any) => Promise<any>;
+}
+/** AppCall接口（可选） */
+export interface AppCallInterface {
+    getAppVersion?: () => string;
+    sendEventMsg?: (data: {
+        eId: string;
+        eventContent: string;
+    }) => Promise<any>;
+}
+/** AB测试标记 */
+export interface AbFlag {
+    indexList: string[];
+    test?: boolean;
+    [key: string]: any;
+}
+/** 设备数据 */
+export interface DeviceData {
+    deviceId?: string;
+    network?: string;
+    [key: string]: any;
+}
+/** 用户数据 */
+export interface UserData {
+    uid?: string | number;
+    [key: string]: any;
+}
+/** 位置数据 */
+export interface PositionData {
+    lng?: string | number;
+    lat?: string | number;
+    [key: string]: any;
+}
+/** 单条日志数据 */
+export interface LogItem {
+    uid: string;
+    eventid: string;
+    eventcontent: string;
+    begintime: number;
+    pmenu: string;
+    menu: string;
+    net: string;
+    lon: string;
+    lat: string;
+    areacode: string;
+    address: string;
+}
+/** 埋点请求数据 */
+export interface TrackPostData {
+    deviceid: string;
+    plateform: Platform;
+    subplateform: string;
+    version: string;
+    channel: string;
+    client: string;
+    os: string;
+    useragent: string;
+    logs: LogItem[];
+}
+/** 埋点参数 */
+export interface TrackParams {
+    /** 事件ID */
+    eId: string;
+    /** 事件内容（JSON字符串） */
+    eventContent?: string;
+    /** 是否使用AB测试上报 */
+    isAbTest?: boolean;
+}
+/** 错误上报内容 */
+export interface ErrorContent {
+    /** 错误信息 */
+    err: string;
+    /** 应用类型 */
+    apptype?: string;
+    /** 页面URL */
+    url?: string;
+    /** 平台 */
+    platform?: string;
+    [key: string]: any;
+}

package/dist/modules/track/types.js

@@ -0,0 +1,4 @@
+/**
+ * Track 模块类型定义
+ */
+export {};

package/dist/modules/upload/aliOss.d.ts

@@ -14,7 +14,10 @@
  *   darkWaterUploadImage: (params) => api.darkWaterUploadImage(params),
  *   multiTransferImage: (params) => api.multiTransferImage(params),
  *   generatePrePresignedUrl: (params) => api.generatePrePresignedUrl(params),
- *   messageWarning: (msg) => window.$message.warning(msg)
+ *   messageWarning: (msg) => window.$message.warning(msg),
+ *   // 可选：开启错误上报
+ *   enableErrorReport: true,
+ *   appName: 'emoto'
  * })
  *
  * // 图片上传
@@ -41,6 +44,7 @@
  * })
  * ```
  */
+import type { TrackConfig } from '../track';
 /**
  * 业务类型枚举
  */
@@ -164,6 +168,10 @@ interface ApiResponse<T = any> {
  * 业务相关的API通过此接口传入，实现业务逻辑解耦
  */
 export interface AliOssApiConfig {
+    /** 应用名称，用于错误上报 */
+    appName?: TrackConfig['appName'];
+    /** 是否启用错误上报，默认 false */
+    enableErrorReport?: boolean;
     /** 获取STS，POST V4签名独有的表单元素- 必需 */
     /** businessType: 业务编码(必传), docType: 文件格式如png(必传)，size: _1024_567(可选) */
     getSts: (params: {
@@ -194,8 +202,15 @@ export interface AliOssApiConfig {
 export declare class AliOssClass {
     private static instance;
     private apiConfig;
+    private tracker;
     private constructor();
     static getInstance(apiConfig: AliOssApiConfig): AliOssClass;
+    /**
+     * 上报上传错误
+     * @param err 错误信息
+     * @param extra 额外信息
+     */
+    private reportError;
     /**
      * 判断文件是否为图片（支持常见图片格式）
      * @param {File} file - 上传的File对象

package/dist/modules/upload/aliOss.js

@@ -14,7 +14,10 @@
  *   darkWaterUploadImage: (params) => api.darkWaterUploadImage(params),
  *   multiTransferImage: (params) => api.multiTransferImage(params),
  *   generatePrePresignedUrl: (params) => api.generatePrePresignedUrl(params),
- *   messageWarning: (msg) => window.$message.warning(msg)
+ *   messageWarning: (msg) => window.$message.warning(msg),
+ *   // 可选：开启错误上报
+ *   enableErrorReport: true,
+ *   appName: 'emoto'
  * })
  *
  * // 图片上传
@@ -42,6 +45,7 @@
  * ```
  */
 import lrz from 'lrz';
+import { createTracker } from '../track';
 // ==================== 常量定义 ====================
 /** 支持的图片格式 */
 const SUPPORTED_IMAGE_TYPES = [
@@ -187,8 +191,15 @@ function getFileSizeInMB(size) {
 export class AliOssClass {
     static instance = null;
     apiConfig;
+    tracker = null;
     constructor(apiConfig) {
         this.apiConfig = apiConfig;
+        // 只有启用错误上报时才创建 tracker 实例
+        if (apiConfig.enableErrorReport) {
+            this.tracker = createTracker({
+                appName: apiConfig.appName
+            });
+        }
     }
     static getInstance(apiConfig) {
         if (!AliOssClass.instance) {
@@ -196,6 +207,22 @@ export class AliOssClass {
         }
         return AliOssClass.instance;
     }
+    /**
+     * 上报上传错误
+     * @param err 错误信息
+     * @param extra 额外信息
+     */
+    reportError(err, extra) {
+        // 只有启用错误上报且 tracker 存在时才上报
+        if (!this.apiConfig.enableErrorReport || !this.tracker) {
+            return;
+        }
+        this.tracker.trackError({
+            err: err,
+            apptype: '10003',
+            ...extra
+        });
+    }
     /**
      * 判断文件是否为图片（支持常见图片格式）
      * @param {File} file - 上传的File对象
@@ -238,10 +265,12 @@ export class AliOssClass {
                 size: size, // _1024_567(可选)
             });
             if (signResponse.data.code !== 0) {
-                const errorMessage = `获取签名失败：${signResponse.data.message}`;
+                const errorMessage = `获取签名失败：${signResponse.data.message || signResponse.data.msg}`;
                 callbacks?.onError(errorMessage);
                 reject && reject(errorMessage);
                 console.error(errorMessage);
+                this.reportError(errorMessage, { type: 'getSts', businessType, code: signResponse.data.code });
+                return result;
             }
             const signData = await signResponse.data.data;
             // console.log('后端返回的签名字段：', signData)
@@ -285,12 +314,15 @@ export class AliOssClass {
                 callbacks?.onError(errorMessage);
                 reject && reject(errorMessage);
                 console.error(errorMessage);
+                this.reportError(errorMessage, { type: 'ossUpload', businessType, status: uploadResponse.status });
             }
         }
         catch (err) {
-            callbacks?.onError(err.message);
-            reject && reject(err.message);
-            console.error('上传异常：', err.message);
+            const errMsg = err.message || err.msg || '上传异常';
+            callbacks?.onError(errMsg);
+            reject && reject(errMsg);
+            console.error('上传异常：', errMsg);
+            this.reportError(errMsg, { type: 'ossUploadException', businessType });
         }
         return result;
     }
@@ -417,6 +449,7 @@ export class AliOssClass {
                     else {
                         callbacks.onError('上传失败');
                         reject('上传失败');
+                        this.reportError('批量转换水印上传失败', { type: 'batchTransfer', businessType });
                     }
                     return;
                 }
@@ -437,6 +470,7 @@ export class AliOssClass {
                     else {
                         callbacks.onError('上传失败');
                         reject('上传失败');
+                        this.reportError('暗水印上传失败', { type: 'darkWater', businessType });
                     }
                     return;
                 }
@@ -496,14 +530,16 @@ export class AliOssClass {
                     else {
                         callbacks.onError('生成预签名URL失败');
                         reject('生成预签名URL失败');
+                        this.reportError('生成预签名URL失败', { type: 'preSignedUrl', businessType });
                     }
                     return;
                 }
             }
             catch (error) {
-                const errorMsg = error.message || '上传异常';
+                const errorMsg = error.message || error.msg || '上传异常';
                 callbacks.onError(errorMsg);
                 reject(errorMsg);
+                this.reportError(errorMsg, { type: 'ossUploadImage', businessType: option.businessType });
             }
         });
     };
@@ -542,9 +578,10 @@ export class AliOssClass {
                 });
             }
             catch (error) {
-                const errorMsg = error.message || '上传异常';
+                const errorMsg = error.message || error.msg || '上传异常';
                 callbacks.onError(errorMsg);
                 reject(errorMsg);
+                this.reportError(errorMsg, { type: 'ossUploadFile', businessType: option.businessType });
             }
         });
     };
@@ -605,9 +642,10 @@ export class AliOssClass {
                 });
             }
             catch (error) {
-                const errorMsg = error.message || '上传异常';
+                const errorMsg = error.message || error.msg || '上传异常';
                 callbacks.onError(errorMsg);
                 reject(errorMsg);
+                this.reportError(errorMsg, { type: 'pureOssUploadImage', businessType: option.businessType });
             }
         });
     };