@galacean/effects-specification 0.0.1 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Galacean
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,28 +1,22 @@
 # Galacean Effects JSON definition
 
-## 环境准备
+## Environment Setup
 
 - Node.js `>= 10.0.0`
 
-## 本地开发
+## Development
 
 ``` bash
-# 1. 安装依赖（首次）
+# 1. Install dependencies (first time)
 npm install
-# 2. 编译
+# 2. Build
 npm run build
 ```
 
-## 测试
+## Testing
 
 ``` bash
 npm run test
 ```
 
-> 浏览器打开：http://localhost:9003/test/
-
-## 发布
-
-``` bash
-tnpm publish
-```
+> Open browser and open: http://localhost:9003/test/

package/dist/fallback/migration.d.ts

@@ -3,3 +3,7 @@ import type { JSONScene } from '../src/scene';
  * 2.1 以下版本数据适配（mars-player@2.4.0 及以上版本支持 2.1 以下数据的适配）
  */
 export declare function version21Migration(json: JSONScene): JSONScene;
+/**
+ * 2.2 以下版本数据适配（mars-player@2.5.0 及以上版本支持 2.2 以下数据的适配）
+ */
+export declare function version22Migration(json: JSONScene): JSONScene;

package/dist/fallback.js

@@ -2,7 +2,7 @@
  * Name: @galacean/effects-specification
  * Description: Galacean Effects JSON Specification
  * Author: Ant Group CO., Ltd.
- * Version: v0.0.1
+ * Version: v1.0.0
  */
 
 'use strict';
@@ -477,7 +477,7 @@ var ItemEndBehavior;
 (function (ItemEndBehavior) {
     ItemEndBehavior[ItemEndBehavior["destroy"] = END_BEHAVIOR_DESTROY] = "destroy";
     ItemEndBehavior[ItemEndBehavior["loop"] = END_BEHAVIOR_RESTART] = "loop";
-    ItemEndBehavior[ItemEndBehavior["forward"] = END_BEHAVIOR_FREEZE] = "forward";
+    ItemEndBehavior[ItemEndBehavior["freeze"] = END_BEHAVIOR_FREEZE] = "freeze";
 })(ItemEndBehavior || (ItemEndBehavior = {}));
 var ParentItemEndBehavior;
 (function (ParentItemEndBehavior) {
@@ -723,7 +723,12 @@ function __read(o, n) {
         finally { if (e) throw e.error; }
     }
     return ar;
-}
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
 
 function arrAdd(arr, item) {
     if (!arr.includes(item)) {
@@ -1345,7 +1350,7 @@ function version21Migration(json) {
         composition.items.forEach(function (item) {
             if (item.type === ItemType.null) {
                 if (item.endBehavior === ItemEndBehavior.destroy) {
-                    item.endBehavior = ItemEndBehavior.forward;
+                    item.endBehavior = ItemEndBehavior.freeze;
                 }
             }
         });
@@ -1353,6 +1358,24 @@ function version21Migration(json) {
     json.version = '2.1';
     return json;
 }
+/**
+ * 2.2 以下版本数据适配（mars-player@2.5.0 及以上版本支持 2.2 以下数据的适配）
+ */
+function version22Migration(json) {
+    var _a;
+    var singleVersion = (_a = json.version) === null || _a === void 0 ? void 0 : _a.split('.');
+    if (!singleVersion || Number(singleVersion[0]) > 2 || (Number(singleVersion[0]) === 2 && Number(singleVersion[1]) >= 2)) {
+        return json;
+    }
+    json.compositions.forEach(function (composition) {
+        composition.items.forEach(function (item) {
+            if (item.type === ItemType.mesh || item.type === ItemType.light) {
+                item.endBehavior = item.endBehavior === 1 ? ItemEndBehavior.destroy : item.endBehavior;
+            }
+        });
+    });
+    return json;
+}
 
 var v0 = /^(\d+)\.(\d+)\.(\d+)(-(\w+)\.\d+)?$/;
 var standardVersion = /^(\d+)\.(\d+)$/;
@@ -1362,6 +1385,8 @@ function getStandardJSON(json) {
     if (!json || typeof json !== 'object') {
         throw Error('expect a json object');
     }
+    // 修正老版本数据中，meshItem以及lightItem结束行为错误问题
+    version22Migration(json);
     if (v0.test(json.version)) {
         reverseParticle = ((_a = (/^(\d+)/).exec(json.version)) === null || _a === void 0 ? void 0 : _a[0]) === '0';
         return version21Migration(getStandardJSONFromV0(json));