@galacean/effects-plugin-downgrade 2.0.0-alpha.28 → 2.0.0-alpha.30

package/dist/index.mjs

@@ -3,7 +3,7 @@
  * Description: Galacean Effects player downgrade plugin
  * Author: Ant Group CO., Ltd.
  * Contributors: 飂兮
- * Version: v2.0.0-alpha.28
+ * Version: v2.0.0-alpha.30
  */
 
 import * as EFFECTS from '@galacean/effects';
@@ -158,17 +158,6 @@ typeof SuppressedError === "function" ? SuppressedError : function _SuppressedEr
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 };
 
-function _extends() {
-    _extends = Object.assign || function assign(target) {
-        for(var i = 1; i < arguments.length; i++){
-            var source = arguments[i];
-            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
-        }
-        return target;
-    };
-    return _extends.apply(this, arguments);
-}
-
 function _array_like_to_array(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
@@ -204,7 +193,9 @@ function _create_for_of_iterator_helper_loose(o, allowArrayLike) {
     throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
 
-var infoList = {
+/**
+ * 部分手机厂商和 iPhone 机型列表
+ */ var infoList = {
     vender: [
         "SAMSUNG"
     ],
@@ -463,7 +454,9 @@ var infoList = {
         }
     ]
 };
-var downgradeModels = {
+/**
+ * 被降级的硬件机型列表
+ */ var downgradeModels = {
     android: [
         "OPPO R9s Plus",
         "GM1910",
@@ -511,7 +504,9 @@ var downgradeModels = {
         "iPhone1,1"
     ]
 };
-var downgradeVersions = {
+/**
+ * 被降级的系统版本列表
+ */ var downgradeVersions = {
     android: [],
     iOS: [
         "16.7",
@@ -523,7 +518,9 @@ var downgradeVersions = {
         "16.7.6"
     ]
 };
-var devtoolNameMap = {
+/**
+ * 微信开发环境机型名称替换表
+ */ var devtoolNameMap = {
     wechat: {
         "iPhone 6/7/8": "iPhone 8",
         "iPhone 6/7/8 Plus": "iPhone 8 Plus",
@@ -541,7 +538,11 @@ var DeviceLevel;
     DeviceLevel["Unknown"] = "unknown";
 })(DeviceLevel || (DeviceLevel = {}));
 
-var UADecoder = /*#__PURE__*/ function() {
+/**
+ * UserAgent 解析类
+ *
+ * 从 UserAgent 中解析出设备相关的信息，但是能获取的信息有限。
+ */ var UADecoder = /*#__PURE__*/ function() {
     function UADecoder(userAgent) {
         this.device = {};
         this.parse(userAgent != null ? userAgent : navigator.userAgent);
@@ -754,7 +755,11 @@ var UADecoder = /*#__PURE__*/ function() {
     return UADecoder;
 }();
 
-var AlipayMiniprogramParser = /*#__PURE__*/ function() {
+/**
+ * 支付宝小程序系统信息解析类
+ *
+ * 负责解析支付宝小程序 JSAPI 返回的系统信息
+ */ var AlipayMiniprogramParser = /*#__PURE__*/ function() {
     function AlipayMiniprogramParser(info) {
         this.device = {};
         this.parse(info);
@@ -802,7 +807,11 @@ var AlipayMiniprogramParser = /*#__PURE__*/ function() {
     return AlipayMiniprogramParser;
 }();
 
-var WechatMiniprogramParser = /*#__PURE__*/ function() {
+/**
+ * 微信小程序设备信息解析类
+ *
+ * 负责解析微信小程序 JSAPI 返回的设备信息
+ */ var WechatMiniprogramParser = /*#__PURE__*/ function() {
     function WechatMiniprogramParser(info) {
         this.device = {};
         this.parse(info);
@@ -857,14 +866,23 @@ var WechatMiniprogramParser = /*#__PURE__*/ function() {
     return WechatMiniprogramParser;
 }();
 
-var DowngradeJudge = /*#__PURE__*/ function() {
+/**
+ * 降级判断类
+ *
+ * 通过设备信息和降级选项判断设备是否需要降级
+ */ var DowngradeJudge = /*#__PURE__*/ function() {
     function DowngradeJudge(options, device) {
         this.options = options;
         this.device = device;
         this.isIOS = false;
     }
     var _proto = DowngradeJudge.prototype;
-    _proto.getDowngradeResult = function getDowngradeResult() {
+    /**
+   * 根据输入的设备信息和降级选项，以及内置的硬件机型和系统版本降级列表
+   * 返回当前设备降级相关的结果
+   *
+   * @returns 降级结果
+   */ _proto.getDowngradeResult = function getDowngradeResult() {
         var _this = this;
         var downgradeCallback = this.options.downgradeCallback;
         if (downgradeCallback) {
@@ -918,6 +936,9 @@ var DowngradeJudge = /*#__PURE__*/ function() {
         };
     };
     _proto.getRenderLevel = function getRenderLevel() {
+        if (this.options.level) {
+            return this.options.level;
+        }
         if (this.device.level) {
             if (this.device.level === DeviceLevel.High) {
                 return spec.RenderLevel.S;
@@ -927,15 +948,6 @@ var DowngradeJudge = /*#__PURE__*/ function() {
                 return spec.RenderLevel.B;
             }
         }
-        if (this.device.memoryMB) {
-            if (this.device.memoryMB < 4000) {
-                return spec.RenderLevel.B;
-            } else if (this.device.memoryMB < 6000) {
-                return spec.RenderLevel.A;
-            } else {
-                return spec.RenderLevel.S;
-            }
-        }
         if (this.isIOS && this.device.model) {
             if (/iPhone(\d+),/.test(this.device.model)) {
                 var gen = +RegExp.$1;
@@ -948,6 +960,15 @@ var DowngradeJudge = /*#__PURE__*/ function() {
                 }
             }
         }
+        if (this.device.memoryMB) {
+            if (this.device.memoryMB < 4000) {
+                return spec.RenderLevel.B;
+            } else if (this.device.memoryMB < 6000) {
+                return spec.RenderLevel.A;
+            } else {
+                return spec.RenderLevel.S;
+            }
+        }
         return this.isIOS ? spec.RenderLevel.S : spec.RenderLevel.B;
     };
     return DowngradeJudge;
@@ -955,17 +976,26 @@ var DowngradeJudge = /*#__PURE__*/ function() {
 
 var internalPaused = Symbol("@@_inter_pause");
 var hasRegisterEvent = false;
-function getDowngradeResult(options) {
+/**
+ * 获取 GE 降级结果，不需要创建 Canvas 和 WebGL 环境。
+ * 如果是小程序环境下，要确保 JSAPI 可调用
+ *
+ * @param options - 降级选项
+ * @returns 降级结果
+ */ function getDowngradeResult(options) {
     if (options === void 0) options = {};
     if (!hasRegisterEvent) {
         registerEvent(options);
         hasRegisterEvent = true;
     }
-    var mock = options.mock;
-    if (mock) {
-        return _extends({}, mock, {
+    var mockDowngrade = options.mockDowngrade;
+    if (mockDowngrade !== undefined) {
+        var _options_level;
+        return {
+            downgrade: mockDowngrade,
+            level: (_options_level = options.level) != null ? _options_level : spec.RenderLevel.S,
             reason: "mock"
-        });
+        };
     }
     var device = getDeviceInfo(options);
     var judge = new DowngradeJudge(options, device);
@@ -1018,7 +1048,11 @@ function getDeviceInfo(options) {
     }
     return new UADecoder().getDeviceInfo();
 }
-function getDefaultRenderLevel() {
+/**
+ * 获取默认渲染等级
+ *
+ * @returns 渲染等级
+ */ function getDefaultRenderLevel() {
     return isIOS() ? spec.RenderLevel.S : spec.RenderLevel.B;
 }
 function pauseAllActivePlayers(e) {
@@ -1051,7 +1085,15 @@ function resumePausedPlayers(e) {
     }
 }
 
-var DowngradePlugin = /*#__PURE__*/ function(AbstractPlugin) {
+/**
+ * 降级插件类
+ *
+ * 根据 SceneLoadOptions 中传入的 downgrade 数据，判断是否降级。
+ * 如果设备被降级，会在 processRawJSON 时抛出降级相关的异常和原因。
+ *
+ * 如果 SceneLoadOptions 中 renderLevel 没有设置，那么会根据 downgrade 数据
+ * 和默认的渲染等级规则设置其中的 renderLevel 。
+ */ var DowngradePlugin = /*#__PURE__*/ function(AbstractPlugin) {
     _inherits(DowngradePlugin, AbstractPlugin);
     function DowngradePlugin() {
         return AbstractPlugin.apply(this, arguments);
@@ -1059,18 +1101,18 @@ var DowngradePlugin = /*#__PURE__*/ function(AbstractPlugin) {
     DowngradePlugin.processRawJSON = function processRawJSON(json, options) {
         if (options === void 0) options = {};
         return _async_to_generator(function() {
-            var _options_pluginData, downgradeResult, _downgradeResult_renderLevel;
+            var _options_pluginData, downgradeResult, _downgradeResult_level;
             return __generator(this, function(_state) {
                 downgradeResult = (_options_pluginData = options.pluginData) == null ? void 0 : _options_pluginData["downgrade"];
                 if (downgradeResult) {
                     if (downgradeResult.downgrade) {
-                        throw new Error("Downgraded, reason: " + downgradeResult.reason + ".");
+                        throw new Error("Downgraded, reason: " + downgradeResult.reason);
                     }
                 } else {
                     logger.warn("No downgrade result in pluginData of SceneLoadOptions.");
                 }
                 if (!options.renderLevel) {
-                    options.renderLevel = (_downgradeResult_renderLevel = downgradeResult == null ? void 0 : downgradeResult.renderLevel) != null ? _downgradeResult_renderLevel : getDefaultRenderLevel();
+                    options.renderLevel = (_downgradeResult_level = downgradeResult == null ? void 0 : downgradeResult.level) != null ? _downgradeResult_level : getDefaultRenderLevel();
                 }
                 return [
                     2
@@ -1081,7 +1123,7 @@ var DowngradePlugin = /*#__PURE__*/ function(AbstractPlugin) {
     return DowngradePlugin;
 }(AbstractPlugin);
 
-var version = "2.0.0-alpha.28";
+var version = "2.0.0-alpha.30";
 registerPlugin("downgrade", DowngradePlugin, VFXItem, true);
 logger.info("Plugin downgrade version: " + version + ".");
 if (version !== EFFECTS.version) {