@zeewain/3d-avatar-sdk 1.2.5 → 2.1.2

package/dist/index.esm.js

@@ -107,6 +107,8 @@ var ResourceErrorCode;
     ResourceErrorCode[ResourceErrorCode["NOT_FOUND"] = 3003] = "NOT_FOUND";
     /** 资源格式不支持 */
     ResourceErrorCode[ResourceErrorCode["UNSUPPORTED_FORMAT"] = 3004] = "UNSUPPORTED_FORMAT";
+    /** 资源版本不兼容 */
+    ResourceErrorCode[ResourceErrorCode["VERSION_INCOMPATIBLE"] = 3005] = "VERSION_INCOMPATIBLE";
 })(ResourceErrorCode || (ResourceErrorCode = {}));
 /**
  * 系统错误码 (4xxx)
@@ -213,6 +215,10 @@ const ERROR_CODE_MAP = {
         category: ErrorCategory.RESOURCE,
         message: '资源格式不支持'
     },
+    [ResourceErrorCode.VERSION_INCOMPATIBLE]: {
+        category: ErrorCategory.RESOURCE,
+        message: '资源版本不兼容'
+    },
     // 系统错误
     [SystemErrorCode.OUT_OF_MEMORY]: {
         category: ErrorCategory.SYSTEM,
@@ -401,6 +407,44 @@ class SDKError extends Error {
     }
 }
 
+/**
+ * Unity服务日志级别枚举
+ * @enum {string}
+ * @description 定义日志记录的级别
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["DEBUG"] = "debug";
+    LogLevel["INFO"] = "info";
+    LogLevel["WARN"] = "warn";
+    LogLevel["ERROR"] = "error";
+})(LogLevel || (LogLevel = {}));
+/**
+ * 简单日志记录器实现
+ * @class SimpleLogger
+ * @implements {ISimpleLogger}
+ * @description 提供基础的日志记录功能
+ */
+class SimpleLogger {
+    constructor(enableDebug = false) {
+        this.enableDebug = enableDebug;
+    }
+    debug(message, data) {
+        if (this.enableDebug) {
+            console.debug(`[SDK DEBUG] ${message}`, data);
+        }
+    }
+    info(message, data) {
+        console.info(`[SDK INFO] ${message}`, data);
+    }
+    warn(message, data) {
+        console.warn(`[SDK WARN] ${message}`, data);
+    }
+    error(message, error, data) {
+        console.error(`[SDK ERROR] ${message}`, error, error instanceof SDKError ? error.code : null, data);
+    }
+}
+
 /**
  * @fileoverview Unity服务基础类型定义
  * @description 定义Unity服务的通用接口和类型，为所有Unity服务提供统一的基础类型
@@ -421,18 +465,6 @@ var UnityOperationStatus;
     /** 操作取消 */
     UnityOperationStatus[UnityOperationStatus["CANCELLED"] = 3] = "CANCELLED";
 })(UnityOperationStatus || (UnityOperationStatus = {}));
-/**
- * Unity服务日志级别枚举
- * @enum {string}
- * @description 定义日志记录的级别
- */
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["DEBUG"] = "debug";
-    LogLevel["INFO"] = "info";
-    LogLevel["WARN"] = "warn";
-    LogLevel["ERROR"] = "error";
-})(LogLevel || (LogLevel = {}));
 
 /**
  * @fileoverview Unity服务抽象基类
@@ -717,31 +749,6 @@ class UnityBaseService {
         });
     }
 }
-/**
- * 简单日志记录器实现
- * @class SimpleLogger
- * @implements {IUnityLogger}
- * @description 提供基础的日志记录功能
- */
-class SimpleLogger {
-    constructor(enableDebug = false) {
-        this.enableDebug = enableDebug;
-    }
-    debug(message, data) {
-        if (this.enableDebug) {
-            console.debug(`[Unity Debug] ${message}`, data);
-        }
-    }
-    info(message, data) {
-        console.info(`[Unity Info] ${message}`, data);
-    }
-    warn(message, data) {
-        console.warn(`[Unity Warning] ${message}`, data);
-    }
-    error(message, error, data) {
-        console.error(`[Unity Error] ${message}`, error, error instanceof SDKError ? error.code : null, data);
-    }
-}
 
 /**
  * @fileoverview Avatar API接口定义
@@ -836,6 +843,9 @@ class AvatarService extends UnityBaseService {
             }
         });
     }
+    handleCallback(operation, code, message, data) {
+        super.handleCallback(operation, code, message, data);
+    }
     /**
      * 播放数字人动作
      * @param clipCode - 动作编码
@@ -1073,6 +1083,16 @@ class ConfigManager {
     setConfig(config) {
         this.config = Object.assign(Object.assign({}, config), { env: config.env || 'prod', containerId: config.containerId || 'unity-container' });
     }
+    /**
+     * 更新SDK配置
+     * @param config - SDK配置对象
+     * @description 更新全局SDK配置
+     */
+    updateConfig(config) {
+        if (this.config) {
+            this.config = Object.assign(Object.assign({}, this.config), config);
+        }
+    }
     /**
      * 获取SDK配置
      * @returns IAvatarSDKConfig | null SDK配置对象或null
@@ -1081,24 +1101,6 @@ class ConfigManager {
     getConfig() {
         return this.config;
     }
-    /**
-     * 获取认证token
-     * @returns string 认证token
-     * @description 获取当前配置的认证token
-     */
-    getToken() {
-        var _a;
-        return ((_a = this.config) === null || _a === void 0 ? void 0 : _a.token) || '';
-    }
-    /**
-     * 获取环境类型
-     * @returns string 环境类型
-     * @description 获取当前配置的环境类型
-     */
-    getEnv() {
-        var _a;
-        return ((_a = this.config) === null || _a === void 0 ? void 0 : _a.env) || 'prod';
-    }
     /**
      * 获取API基础URL
      * @param withApiModule 是否包含模块路径
@@ -1113,15 +1115,6 @@ class ConfigManager {
         }
         return ((_d = getEnvConfig(((_c = this.config) === null || _c === void 0 ? void 0 : _c.env) || 'prod', withApiModule)) === null || _d === void 0 ? void 0 : _d.apiBaseUrl) || '';
     }
-    /**
-     * 获取自定义API URL
-     * @returns string | undefined 自定义API URL
-     * @description 获取自定义API URL配置
-     */
-    getCustomApiUrl() {
-        var _a;
-        return (_a = this.config) === null || _a === void 0 ? void 0 : _a.apiUrl;
-    }
     /**
      * 重置配置
      * @description 清空当前配置
@@ -1891,6 +1884,7 @@ class BroadcastService extends UnityBaseService {
      */
     startTaskRequest(task) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             task.status = BroadcastTaskStatus.REQUESTING;
             this.logger.debug('Starting task request', { taskId: task.id });
             try {
@@ -1899,7 +1893,8 @@ class BroadcastService extends UnityBaseService {
                     humanCode: task.params.humanCode,
                     speed: task.params.speed,
                     volume: task.params.volume >= 0 ? task.params.volume * 100 : undefined,
-                    isSubtitle: task.params.isSubtitle
+                    isSubtitle: task.params.isSubtitle,
+                    audioDrivenVersion: ConfigManager.getInstance().getConfig().audioDrivenVersion
                 };
                 // 根据播报类型设置特定参数
                 if (task.params.type === BroadcastType.TEXT) {
@@ -1915,11 +1910,24 @@ class BroadcastService extends UnityBaseService {
                     method: 'POST',
                     headers: {
                         'Content-Type': 'application/json',
-                        'x_auth_token': ConfigManager.getInstance().getToken()
+                        'x_auth_token': ((_a = ConfigManager.getInstance().getConfig()) === null || _a === void 0 ? void 0 : _a.token) || ''
                     },
                     body: JSON.stringify(requestBody),
                     signal: task.controller.signal,
                     openWhenHidden: true,
+                    /**
+                     * 连接建立时的回调，用于检查 HTTP 状态码
+                     * @param response - HTTP 响应对象
+                     * @throws {SDKError} 当 HTTP 状态码异常时抛出对应的 SDKError
+                     */
+                    onopen: (response) => __awaiter(this, void 0, void 0, function* () {
+                        // 检查 HTTP 状态码，处理 401 token 过期等异常
+                        if (!response.ok) {
+                            const error = this.createHttpError(response.status, response.statusText, task.id);
+                            this.handleTaskError(task, error);
+                            throw error;
+                        }
+                    }),
                     onmessage: (event) => {
                         this.handleTaskResponse(task, event.data);
                     },
@@ -1927,13 +1935,17 @@ class BroadcastService extends UnityBaseService {
                         this.handleTaskClose(task);
                     },
                     onerror: (error) => {
-                        this.handleTaskError(task, error);
-                        throw new Error(`Task ${task.id} request failed: ${error}`);
+                        // 将所有异常统一转换为 SDKError
+                        const sdkError = this.convertToSDKError(error, task.id);
+                        this.handleTaskError(task, sdkError);
+                        throw sdkError;
                     }
                 });
             }
             catch (error) {
-                this.handleTaskError(task, error);
+                // 将所有异常统一转换为 SDKError
+                const sdkError = this.convertToSDKError(error, task.id);
+                this.handleTaskError(task, sdkError);
             }
         });
     }
@@ -2021,15 +2033,19 @@ class BroadcastService extends UnityBaseService {
      * 处理任务错误
      * @param task - 播报任务
      * @param error - 错误对象
-     * @description 处理任务执行过程中的错误
+     * @description 处理任务执行过程中的错误，防止重复触发错误回调
      * @private
      */
     handleTaskError(task, error) {
         var _a, _b;
+        // 如果任务已经是失败或取消状态，不再重复处理，防止回调被多次触发
+        if (task.status === BroadcastTaskStatus.FAILED || task.status === BroadcastTaskStatus.CANCELLED) {
+            return;
+        }
         task.status = BroadcastTaskStatus.FAILED;
         task.error = error;
         this.logger.error(`Task failed - ${task.id}`, error);
-        // 触发错误回调
+        // 触发错误回调（只触发一次）
         (_b = (_a = this.callbacks).onError) === null || _b === void 0 ? void 0 : _b.call(_a, error);
     }
     /**
@@ -2077,7 +2093,6 @@ class BroadcastService extends UnityBaseService {
      * @private
      */
     getBroadcastApiPath(type) {
-        ConfigManager.getInstance().getEnv();
         switch (type) {
             case BroadcastType.TEXT:
                 return '/aiep-openapi/avatar-interaction/v1/broadcast/text';
@@ -2154,6 +2169,71 @@ class BroadcastService extends UnityBaseService {
             this.queueProcessTimer = null;
         }
     }
+    /**
+     * 根据 HTTP 状态码创建对应的 SDKError
+     * @param status - HTTP 状态码
+     * @param statusText - HTTP 状态文本
+     * @param taskId - 任务 ID（用于日志记录）
+     * @returns SDKError 实例
+     * @description 将 HTTP 错误状态码映射为对应的 SDKError
+     * @private
+     */
+    createHttpError(status, statusText, taskId) {
+        this.logger.warn(`HTTP error occurred - Task: ${taskId}, Status: ${status}`, { status, statusText });
+        switch (status) {
+            case 401:
+                // Token 过期或未授权
+                return new SDKError(NetworkErrorCode.UNAUTHORIZED, `Token 已过期或无效，请重新授权 (HTTP ${status})`);
+            case 403:
+                // 禁止访问
+                return new SDKError(NetworkErrorCode.UNAUTHORIZED, `无权限访问该资源 (HTTP ${status})`);
+            case 404:
+                // 资源不存在
+                return new SDKError(NetworkErrorCode.SERVER_ERROR, `请求的资源不存在 (HTTP ${status})`);
+            case 500:
+            case 502:
+            case 503:
+            case 504:
+                // 服务器错误
+                return new SDKError(NetworkErrorCode.SERVER_ERROR, `服务器错误，请稍后重试 (HTTP ${status})`);
+            default:
+                // 其他 HTTP 错误
+                return new SDKError(NetworkErrorCode.CONNECTION_FAILED, `网络请求失败: ${statusText || 'Unknown Error'} (HTTP ${status})`);
+        }
+    }
+    /**
+     * 将任意错误转换为 SDKError
+     * @param error - 原始错误对象
+     * @param taskId - 任务 ID（用于日志记录）
+     * @returns SDKError 实例
+     * @description 统一将各种类型的错误转换为 SDKError，便于上层统一处理
+     * @private
+     */
+    convertToSDKError(error, taskId) {
+        // 如果已经是 SDKError，直接返回
+        if (error instanceof SDKError) {
+            return error;
+        }
+        // 如果是普通 Error 对象
+        if (error instanceof Error) {
+            // 检查是否是网络相关的错误
+            const errorMessage = error.message.toLowerCase();
+            if (errorMessage.includes('timeout') || errorMessage.includes('timed out')) {
+                return new SDKError(NetworkErrorCode.REQUEST_TIMEOUT, `请求超时 - Task: ${taskId}`, error);
+            }
+            if (errorMessage.includes('network') || errorMessage.includes('fetch') || errorMessage.includes('connection')) {
+                return new SDKError(NetworkErrorCode.CONNECTION_FAILED, `网络连接失败 - Task: ${taskId}: ${error.message}`, error);
+            }
+            if (errorMessage.includes('abort') || errorMessage.includes('cancel')) {
+                return new SDKError(OperationErrorCode.OPERATION_CANCELLED, `操作已取消 - Task: ${taskId}`, error);
+            }
+            // 默认作为操作失败处理
+            return new SDKError(OperationErrorCode.OPERATION_FAILED, `播报任务执行失败 - Task: ${taskId}: ${error.message}`, error);
+        }
+        // 如果是字符串或其他类型
+        const errorMessage = String(error);
+        return new SDKError(OperationErrorCode.OPERATION_FAILED, `播报任务执行失败 - Task: ${taskId}: ${errorMessage}`);
+    }
 }
 
 /**
@@ -2171,13 +2251,11 @@ class ZEEAvatarLoader {
      * @param config - Unity配置对象
      * @description 初始化数字人加载器，创建Unity加载器实例
      */
-    constructor(config) {
+    constructor() {
         /** Avatar API实例 */
         this.apiService = null;
         /** Unity实例 */
         this.unityInstance = null;
-        // 同时设置到配置管理器中
-        ConfigManager.getInstance().setConfig(config);
         this.loader = new UnityLoader();
     }
     /**
@@ -2280,17 +2358,61 @@ class ZEEAvatarLoader {
      * @protected
      */
     initGlobalConfig() {
-        const params = {
-            token: ConfigManager.getInstance().getToken(),
+        const config = ConfigManager.getInstance().getConfig();
+        const globalParams = {
+            token: config === null || config === void 0 ? void 0 : config.token,
             apiBaseUrl: ConfigManager.getInstance().getApiBaseUrl(false),
-            idleMotionList: ConfigManager.getInstance().getConfig().idleMotionList,
-            assetsUrl: ConfigManager.getInstance().getConfig().assetsUrl
+            idleMotionList: config === null || config === void 0 ? void 0 : config.idleMotionList
+            // 純AB包方案在SDK 2.1.0 中已弃用
+            // assetsUrl: config?.assetsUrl
         };
-        console.warn('[ Send Unity message ]: AvatarSDK.InitializeConfig', params);
-        this.unityInstance.SendMessage('AvatarSDK', 'InitializeConfig', JSON.stringify(params));
+        const assetModuleParams = {
+            isZip: true,
+            assetBundlePath: config === null || config === void 0 ? void 0 : config.assetsUrl
+        };
+        this.unityInstance.SendMessage('AvatarSDK', 'InitializeConfig', JSON.stringify(globalParams));
+        this.unityInstance.SendMessage('AvatarSDK', 'InitAssetBundleModule', JSON.stringify(assetModuleParams));
+        console.warn('[ Send Unity message ]: AvatarSDK.InitializeConfig', globalParams);
+        console.warn('[ Send Unity message ]: AvatarSDK.InitAssetBundleModule', assetModuleParams);
     }
 }
 
+// 深拷贝
+/**
+ * 比较两个版本号的前两位（major.minor）是否一致
+ * @param version1 版本号1，格式：x.x.x
+ * @param version2 版本号2，格式：x.x.x
+ * @returns boolean 如果前两位一致返回 true，否则返回 false
+ * @description 用于检查 SDK 版本与资源版本是否兼容
+ * @example
+ * compareVersionCompatibility('2.1.0', '2.1.5') // true
+ * compareVersionCompatibility('2.1.0', '2.2.0') // false
+ * compareVersionCompatibility('2.1.0', '3.0.0') // false
+ */
+function compareVersionCompatibility(version1, version2) {
+    // 提取版本号的前两位（major.minor）
+    const getMajorMinor = (version) => {
+        const parts = version.split('.');
+        if (parts.length < 2) {
+            return version;
+        }
+        return `${parts[0]}.${parts[1]}`;
+    };
+    const v1MajorMinor = getMajorMinor(version1);
+    const v2MajorMinor = getMajorMinor(version2);
+    return v1MajorMinor === v2MajorMinor;
+}
+
+/**
+ * @fileoverview SDK 版本号常量
+ * @description 此文件由构建脚本自动生成，请勿手动修改
+ */
+/**
+ * SDK 版本号
+ * @const {string} SDK_VERSION
+ */
+const SDK_VERSION = '2.1.2';
+
 /**
  * @fileoverview 统一的3D数字人SDK入口类
  * @description 提供统一的SDK接口，内部通过组合模式调用各个服务模块
@@ -2323,10 +2445,12 @@ class ZEEAvatarSDK {
         this.unityInstance = null;
         /** SDK初始化状态 */
         this.isInitialized = false;
-        this.config = config;
         this.instanceId = generateUniqueId();
         // 设置全局配置
         ConfigManager.getInstance().setConfig(config);
+        // 设置日志
+        this.logger = new SimpleLogger(ConfigManager.getInstance().getConfig().enableDebugLog);
+        this.logger.info('SDK版本', SDK_VERSION);
     }
     /**
      * 初始化数字人
@@ -2337,12 +2461,14 @@ class ZEEAvatarSDK {
      */
     initializeAvatar(avatarCode_1) {
         return __awaiter(this, arguments, void 0, function* (avatarCode, cameraType = AvatarCameraType.WHOLE) {
+            var _a;
             if (this.isInitialized) {
                 throw new SDKError(OperationErrorCode.OPERATION_FAILED, 'SDK已经初始化，请勿重复初始化');
             }
             try {
+                const config = ConfigManager.getInstance().getConfig();
                 // 1. 创建Unity加载器
-                this.loader = new ZEEAvatarLoader(this.config);
+                this.loader = new ZEEAvatarLoader();
                 // 2. 初始化Unity实例
                 yield this.loader.init();
                 // 3. 获取Unity实例
@@ -2351,18 +2477,31 @@ class ZEEAvatarSDK {
                 this.avatarService = new AvatarService({
                     unityInstance: this.unityInstance,
                     instanceId: this.instanceId,
-                    enableDebugLog: this.config.enableDebugLog
+                    enableDebugLog: config.enableDebugLog
                 });
                 // 5. 创建带有唯一标识符的播报服务
                 this.broadcastService = new BroadcastService({
                     unityInstance: this.unityInstance,
                     instanceId: this.instanceId,
-                    callbacks: this.config.broadcastCallbacks,
-                    enableDebugLog: this.config.enableDebugLog
+                    callbacks: config.broadcastCallbacks,
+                    enableDebugLog: config.enableDebugLog
                 });
                 // 6. 初始化数字人
                 const result = yield this.avatarService.initializeAvatar(avatarCode, cameraType);
                 if (result.success) {
+                    const audioDrivenVersion = (_a = result.data) === null || _a === void 0 ? void 0 : _a.audioDrivenVersion;
+                    config.audioDrivenVersion = audioDrivenVersion;
+                    this.logger.info('AudioDrivenVersion', audioDrivenVersion);
+                    // 7. 检查资源版本兼容性
+                    if (audioDrivenVersion) {
+                        const isCompatible = compareVersionCompatibility(SDK_VERSION, audioDrivenVersion);
+                        if (!isCompatible) {
+                            // 销毁SDK实例
+                            this.destroy();
+                            throw new SDKError(ResourceErrorCode.VERSION_INCOMPATIBLE, `资源版本不兼容: SDK版本为 ${SDK_VERSION}，WebGL资源版本为 ${audioDrivenVersion}，前两位版本号必须一致`);
+                        }
+                        this.logger.info('版本兼容性检查通过', `SDK: ${SDK_VERSION}, 资源: ${audioDrivenVersion}`);
+                    }
                     this.isInitialized = true;
                 }
                 return result;
@@ -2378,8 +2517,7 @@ class ZEEAvatarSDK {
      * @description 更新全局Token配置
      */
     updateToken(token) {
-        this.config.token = token;
-        ConfigManager.getInstance().setConfig(this.config);
+        ConfigManager.getInstance().updateConfig({ token });
         // 如果loader已经初始化，也更新loader的token
         if (this.loader) {
             this.loader.updateToken(token);
@@ -2563,7 +2701,8 @@ class ZEEAvatarSDK {
      * @returns IAvatarSDKConfig 当前配置
      */
     getConfig() {
-        return Object.assign({}, this.config);
+        const config = ConfigManager.getInstance().getConfig();
+        return config ? Object.assign({}, config) : null;
     }
     // ===========================================
     // 私有方法
@@ -2579,4 +2718,4 @@ class ZEEAvatarSDK {
     }
 }
 
-export { AvatarCameraType, AvatarOperationType, AvatarService, BroadcastOperationType, BroadcastService, BroadcastType, ConfigErrorCode, ERROR_CODE_MAP, ErrorCategory, LogLevel, NetworkErrorCode, OperationErrorCode, ResourceErrorCode, SDKError, SystemErrorCode, UnityOperationStatus, ZEEAvatarLoader, ZEEAvatarSDK, getErrorInfo };
+export { AvatarCameraType, AvatarOperationType, AvatarService, BroadcastOperationType, BroadcastService, BroadcastType, ConfigErrorCode, ERROR_CODE_MAP, ErrorCategory, NetworkErrorCode, OperationErrorCode, ResourceErrorCode, SDKError, SDK_VERSION, SystemErrorCode, UnityOperationStatus, ZEEAvatarLoader, ZEEAvatarSDK, getErrorInfo };