Merge pull request #730 from OpenWebGAL/update-webgal-parser-sync

feat: sync webgal-parser interfaces with main WebGAL project

Author: MakinoharaShoko

packages/parser/CHANGELOG.md

@@ -0,0 +1,28 @@
+# WebGAL Parser Changelog
+
+## [4.5.13] - 2025-07-05
+
+### Fixed
+- Fixed interface consistency between `webgal-parser` and main WebGAL project
+- Added missing trailing comma in `commandType` enum to match WebGAL main project
+- Updated `ISceneData` interface to use `ISceneEntry` instead of `sceneEntry` for better type consistency
+
+### Added
+- Added `ISceneEntry` interface as compatibility alias for `sceneEntry`
+- Added comprehensive test cases for new animation parameters:
+  - `wait` command testing
+  - `changeFigure` with `duration`, `enter`, `exit` parameters
+  - `changeBg` with animation and transform parameters
+
+### Improved
+- Enhanced type safety and consistency with main WebGAL project
+- Better test coverage for animation-related features
+- Improved interface documentation
+
+### Technical Notes
+- The parser already supports all animation parameters (`duration`, `enter`, `exit`, `transform`) through its generic argument parsing system
+- No changes to core parsing logic were needed - the parser was already compatible with the latest WebGAL features
+- This update focuses on interface consistency and test coverage improvements
+
+## [4.5.12] - Previous Version
+- Previous stable release with `wait` command support

packages/parser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webgal-parser",
-  "version": "4.5.12",
+  "version": "4.5.13",
   "description": "WebGAL script parser",
   "scripts": {
     "test": "vitest",

packages/parser/src/interface/runtimeInterface.ts

@@ -7,3 +7,9 @@ export interface sceneEntry {
   sceneUrl: string; // 场景url
   continueLine: number; // 继续原场景的行号
 }
+
+/**
+ * 场景栈条目接口 (兼容性别名)
+ * @interface ISceneEntry
+ */
+export interface ISceneEntry extends sceneEntry {}

packages/parser/src/interface/sceneInterface.ts

@@ -1,7 +1,7 @@
 /**
  * 语句类型
  */
-import { sceneEntry } from './runtimeInterface';
+import { sceneEntry, ISceneEntry } from './runtimeInterface';
 import { fileType } from './assets';
 
 export enum commandType {
@@ -38,7 +38,7 @@ export enum commandType {
   setTransition,
   getUserInput,
   applyStyle,
-  wait
+  wait,
 }
 
 /**
@@ -92,7 +92,7 @@ export interface IScene {
  */
 export interface ISceneData {
   currentSentenceId: number; // 当前语句ID
-  sceneStack: Array<sceneEntry>; // 场景栈
+  sceneStack: Array<ISceneEntry>; // 场景栈
   currentScene: IScene; // 当前场景数据
 }
 

packages/parser/test/parser.test.ts

@@ -194,3 +194,62 @@ test("say statement", async () => {
     subScene: []
   });
 });
+
+test("wait command", async () => {
+  const parser = new SceneParser((assetList) => {
+  }, (fileName, assetType) => {
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`wait:1000;`, 'test', 'test');
+  expect(result.sentenceList).toContainEqual({
+    command: commandType.wait,
+    commandRaw: "wait",
+    content: "1000",
+    args: [],
+    sentenceAssets: [],
+    subScene: []
+  });
+});
+
+test("changeFigure with duration and animation args", async () => {
+  const parser = new SceneParser((assetList) => {
+  }, (fileName, assetType) => {
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`changeFigure:stand.png -duration=1000 -enter=fadeIn -exit=fadeOut;`, 'test', 'test');
+  expect(result.sentenceList).toContainEqual({
+    command: commandType.changeFigure,
+    commandRaw: "changeFigure",
+    content: "stand.png",
+    args: [
+      { key: 'duration', value: 1000 },
+      { key: 'enter', value: 'fadeIn' },
+      { key: 'exit', value: 'fadeOut' }
+    ],
+    sentenceAssets: [{ name: "stand.png", url: 'stand.png', type: fileType.figure, lineNumber: 0 }],
+    subScene: []
+  });
+});
+
+test("changeBg with animation parameters", async () => {
+  const parser = new SceneParser((assetList) => {
+  }, (fileName, assetType) => {
+    return fileName;
+  }, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG);
+
+  const result = parser.parse(`changeBg:background.jpg -duration=2000 -enter=slideIn -transform={"alpha":0.8};`, 'test', 'test');
+  expect(result.sentenceList).toContainEqual({
+    command: commandType.changeBg,
+    commandRaw: "changeBg",
+    content: "background.jpg",
+    args: [
+      { key: 'duration', value: 2000 },
+      { key: 'enter', value: 'slideIn' },
+      { key: 'transform', value: '{"alpha":0.8}' }
+    ],
+    sentenceAssets: [{ name: "background.jpg", url: 'background.jpg', type: fileType.background, lineNumber: 0 }],
+    subScene: []
+  });
+});