webgal-parser 4.5.13 → 4.5.17

package/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

package/build/cjs/index.cjs

@@ -38,6 +38,7 @@ var commandType;
     commandType[commandType["getUserInput"] = 31] = "getUserInput";
     commandType[commandType["applyStyle"] = 32] = "applyStyle";
     commandType[commandType["wait"] = 33] = "wait";
+    commandType[commandType["callSteam"] = 34] = "callSteam";
 })(commandType || (commandType = {}));
 
 const SCRIPT_CONFIG = [
@@ -78,6 +79,7 @@ const SCRIPT_CONFIG = [
     { scriptString: 'getUserInput', scriptType: commandType.getUserInput },
     { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
     { scriptString: 'wait', scriptType: commandType.wait },
+    { scriptString: 'callSteam', scriptType: commandType.callSteam },
 ];
 const ADD_NEXT_ARG_LIST = [
     commandType.bgm,
@@ -93,6 +95,7 @@ const ADD_NEXT_ARG_LIST = [
     commandType.playEffect,
     commandType.setTransition,
     commandType.applyStyle,
+    commandType.callSteam,
 ];
 
 /**
@@ -128,10 +131,10 @@ function argsParser(argsRaw, assetSetter) {
     });
     rawArgsList.forEach((e) => {
         const equalSignIndex = e.indexOf('=');
-        let argName = e.slice(0, equalSignIndex);
-        let argValue = e.slice(equalSignIndex + 1);
+        let argName = e.slice(0, equalSignIndex).trim();
+        let argValue = e.slice(equalSignIndex + 1).trim();
         if (equalSignIndex < 0) {
-            argName = e;
+            argName = e.trim();
             argValue = undefined;
         }
         // 判断是不是语音参数
@@ -447,14 +450,16 @@ const scriptParser = (sentenceRaw, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG
     let commandRaw;
     // 正式开始解析
     // 去分号
-    let newSentenceRaw = sentenceRaw.split(/(?<!\\);/)[0];
+    const commentSplit = sentenceRaw.split(/(?<!\\);/);
+    let newSentenceRaw = commentSplit[0];
     newSentenceRaw = newSentenceRaw.replaceAll('\\;', ';');
-    if (newSentenceRaw === '') {
+    const sentenceComment = commentSplit[1] ?? '';
+    if (newSentenceRaw.trim() === '') {
         // 注释提前返回
         return {
             command: commandType.comment,
             commandRaw: 'comment',
-            content: sentenceRaw.split(';')[1] ?? '',
+            content: sentenceComment.trim(),
             args: [{ key: 'next', value: true }],
             sentenceAssets: [],
             subScene: [], // 语句携带的子场景
@@ -1771,7 +1776,7 @@ var uniqWith_1 = uniqWith;
  * @return {IScene} 解析后的场景
  */
 const sceneParser = (rawScene, sceneName, sceneUrl, assetsPrefetcher, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG_MAP) => {
-    const rawSentenceList = rawScene.split('\n'); // 原始句子列表
+    const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
     // 去分号留到后面去做了，现在注释要单独处理
     const rawSentenceListWithoutEmpty = rawSentenceList;
     // .map((sentence) => sentence.split(";")[0])

package/build/cjs/interface/runtimeInterface.d.ts

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

package/build/cjs/interface/sceneInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * 语句类型
  */
-import { sceneEntry } from './runtimeInterface';
+import { ISceneEntry } from './runtimeInterface';
 import { fileType } from './assets';
 export declare enum commandType {
     say = 0,
@@ -37,7 +37,8 @@ export declare enum commandType {
     setTransition = 30,
     getUserInput = 31,
     applyStyle = 32,
-    wait = 33
+    wait = 33,
+    callSteam = 34
 }
 /**
  * 单个参数接口
@@ -86,7 +87,7 @@ export interface IScene {
  */
 export interface ISceneData {
     currentSentenceId: number;
-    sceneStack: Array<sceneEntry>;
+    sceneStack: Array<ISceneEntry>;
     currentScene: IScene;
 }
 /**

package/build/es/index.js

@@ -34,6 +34,7 @@ var commandType;
     commandType[commandType["getUserInput"] = 31] = "getUserInput";
     commandType[commandType["applyStyle"] = 32] = "applyStyle";
     commandType[commandType["wait"] = 33] = "wait";
+    commandType[commandType["callSteam"] = 34] = "callSteam";
 })(commandType || (commandType = {}));
 
 const SCRIPT_CONFIG = [
@@ -74,6 +75,7 @@ const SCRIPT_CONFIG = [
     { scriptString: 'getUserInput', scriptType: commandType.getUserInput },
     { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
     { scriptString: 'wait', scriptType: commandType.wait },
+    { scriptString: 'callSteam', scriptType: commandType.callSteam },
 ];
 const ADD_NEXT_ARG_LIST = [
     commandType.bgm,
@@ -89,6 +91,7 @@ const ADD_NEXT_ARG_LIST = [
     commandType.playEffect,
     commandType.setTransition,
     commandType.applyStyle,
+    commandType.callSteam,
 ];
 
 /**
@@ -124,10 +127,10 @@ function argsParser(argsRaw, assetSetter) {
     });
     rawArgsList.forEach((e) => {
         const equalSignIndex = e.indexOf('=');
-        let argName = e.slice(0, equalSignIndex);
-        let argValue = e.slice(equalSignIndex + 1);
+        let argName = e.slice(0, equalSignIndex).trim();
+        let argValue = e.slice(equalSignIndex + 1).trim();
         if (equalSignIndex < 0) {
-            argName = e;
+            argName = e.trim();
             argValue = undefined;
         }
         // 判断是不是语音参数
@@ -443,14 +446,16 @@ const scriptParser = (sentenceRaw, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG
     let commandRaw;
     // 正式开始解析
     // 去分号
-    let newSentenceRaw = sentenceRaw.split(/(?<!\\);/)[0];
+    const commentSplit = sentenceRaw.split(/(?<!\\);/);
+    let newSentenceRaw = commentSplit[0];
     newSentenceRaw = newSentenceRaw.replaceAll('\\;', ';');
-    if (newSentenceRaw === '') {
+    const sentenceComment = commentSplit[1] ?? '';
+    if (newSentenceRaw.trim() === '') {
         // 注释提前返回
         return {
             command: commandType.comment,
             commandRaw: 'comment',
-            content: sentenceRaw.split(';')[1] ?? '',
+            content: sentenceComment.trim(),
             args: [{ key: 'next', value: true }],
             sentenceAssets: [],
             subScene: [], // 语句携带的子场景
@@ -1767,7 +1772,7 @@ var uniqWith_1 = uniqWith;
  * @return {IScene} 解析后的场景
  */
 const sceneParser = (rawScene, sceneName, sceneUrl, assetsPrefetcher, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG_MAP) => {
-    const rawSentenceList = rawScene.split('\n'); // 原始句子列表
+    const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
     // 去分号留到后面去做了，现在注释要单独处理
     const rawSentenceListWithoutEmpty = rawSentenceList;
     // .map((sentence) => sentence.split(";")[0])

package/build/es/interface/runtimeInterface.d.ts

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

package/build/es/interface/sceneInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * 语句类型
  */
-import { sceneEntry } from './runtimeInterface';
+import { ISceneEntry } from './runtimeInterface';
 import { fileType } from './assets';
 export declare enum commandType {
     say = 0,
@@ -37,7 +37,8 @@ export declare enum commandType {
     setTransition = 30,
     getUserInput = 31,
     applyStyle = 32,
-    wait = 33
+    wait = 33,
+    callSteam = 34
 }
 /**
  * 单个参数接口
@@ -86,7 +87,7 @@ export interface IScene {
  */
 export interface ISceneData {
     currentSentenceId: number;
-    sceneStack: Array<sceneEntry>;
+    sceneStack: Array<ISceneEntry>;
     currentScene: IScene;
 }
 /**

package/build/types/interface/runtimeInterface.d.ts

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

package/build/types/interface/sceneInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * 语句类型
  */
-import { sceneEntry } from './runtimeInterface';
+import { ISceneEntry } from './runtimeInterface';
 import { fileType } from './assets';
 export declare enum commandType {
     say = 0,
@@ -37,7 +37,8 @@ export declare enum commandType {
     setTransition = 30,
     getUserInput = 31,
     applyStyle = 32,
-    wait = 33
+    wait = 33,
+    callSteam = 34
 }
 /**
  * 单个参数接口
@@ -86,7 +87,7 @@ export interface IScene {
  */
 export interface ISceneData {
     currentSentenceId: number;
-    sceneStack: Array<sceneEntry>;
+    sceneStack: Array<ISceneEntry>;
     currentScene: IScene;
 }
 /**

package/build/umd/index.global.js

@@ -37,6 +37,7 @@ var webgalParser = (function (exports) {
       commandType[commandType["getUserInput"] = 31] = "getUserInput";
       commandType[commandType["applyStyle"] = 32] = "applyStyle";
       commandType[commandType["wait"] = 33] = "wait";
+      commandType[commandType["callSteam"] = 34] = "callSteam";
   })(commandType || (commandType = {}));
 
   const SCRIPT_CONFIG = [
@@ -77,6 +78,7 @@ var webgalParser = (function (exports) {
       { scriptString: 'getUserInput', scriptType: commandType.getUserInput },
       { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
       { scriptString: 'wait', scriptType: commandType.wait },
+      { scriptString: 'callSteam', scriptType: commandType.callSteam },
   ];
   const ADD_NEXT_ARG_LIST = [
       commandType.bgm,
@@ -92,6 +94,7 @@ var webgalParser = (function (exports) {
       commandType.playEffect,
       commandType.setTransition,
       commandType.applyStyle,
+      commandType.callSteam,
   ];
 
   /**
@@ -127,10 +130,10 @@ var webgalParser = (function (exports) {
       });
       rawArgsList.forEach((e) => {
           const equalSignIndex = e.indexOf('=');
-          let argName = e.slice(0, equalSignIndex);
-          let argValue = e.slice(equalSignIndex + 1);
+          let argName = e.slice(0, equalSignIndex).trim();
+          let argValue = e.slice(equalSignIndex + 1).trim();
           if (equalSignIndex < 0) {
-              argName = e;
+              argName = e.trim();
               argValue = undefined;
           }
           // 判断是不是语音参数
@@ -446,14 +449,16 @@ var webgalParser = (function (exports) {
       let commandRaw;
       // 正式开始解析
       // 去分号
-      let newSentenceRaw = sentenceRaw.split(/(?<!\\);/)[0];
+      const commentSplit = sentenceRaw.split(/(?<!\\);/);
+      let newSentenceRaw = commentSplit[0];
       newSentenceRaw = newSentenceRaw.replaceAll('\\;', ';');
-      if (newSentenceRaw === '') {
+      const sentenceComment = commentSplit[1] ?? '';
+      if (newSentenceRaw.trim() === '') {
           // 注释提前返回
           return {
               command: commandType.comment,
               commandRaw: 'comment',
-              content: sentenceRaw.split(';')[1] ?? '',
+              content: sentenceComment.trim(),
               args: [{ key: 'next', value: true }],
               sentenceAssets: [],
               subScene: [], // 语句携带的子场景
@@ -1770,7 +1775,7 @@ var webgalParser = (function (exports) {
    * @return {IScene} 解析后的场景
    */
   const sceneParser = (rawScene, sceneName, sceneUrl, assetsPrefetcher, assetSetter, ADD_NEXT_ARG_LIST, SCRIPT_CONFIG_MAP) => {
-      const rawSentenceList = rawScene.split('\n'); // 原始句子列表
+      const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
       // 去分号留到后面去做了，现在注释要单独处理
       const rawSentenceListWithoutEmpty = rawSentenceList;
       // .map((sentence) => sentence.split(";")[0])

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "webgal-parser",
-  "version": "4.5.13",
+  "version": "4.5.17",
   "description": "WebGAL script parser",
   "scripts": {
     "test": "vitest",
     "coverage": "vitest run --coverage",
     "build": "rimraf -rf ./build && rollup --config",
+    "prepublishOnly": "npm run build",
     "build-ci": "rollup --config",
     "debug": "tsx test/debug.ts",
     "debug-scss-parser": "tsx test/debugCssParser.ts",

package/src/config/scriptConfig.ts

@@ -38,6 +38,7 @@ export const SCRIPT_CONFIG = [
   { scriptString: 'getUserInput', scriptType: commandType.getUserInput },
   { scriptString: 'applyStyle', scriptType: commandType.applyStyle },
   { scriptString: 'wait', scriptType: commandType.wait },
+  { scriptString: 'callSteam', scriptType: commandType.callSteam },
 ];
 export const ADD_NEXT_ARG_LIST = [
   commandType.bgm,
@@ -53,6 +54,7 @@ export const ADD_NEXT_ARG_LIST = [
   commandType.playEffect,
   commandType.setTransition,
   commandType.applyStyle,
+  commandType.callSteam,
 ];
 
 export type ConfigMap = Map<string, ConfigItem>;

package/src/interface/runtimeInterface.ts

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

package/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,8 @@ export enum commandType {
   setTransition,
   getUserInput,
   applyStyle,
-  wait
+  wait,
+  callSteam, // 调用Steam功能
 }
 
 /**
@@ -92,7 +93,7 @@ export interface IScene {
  */
 export interface ISceneData {
   currentSentenceId: number; // 当前语句ID
-  sceneStack: Array<sceneEntry>; // 场景栈
+  sceneStack: Array<ISceneEntry>; // 场景栈
   currentScene: IScene; // 当前场景数据
 }
 

package/src/sceneParser.ts

@@ -29,7 +29,7 @@ export const sceneParser = (
   ADD_NEXT_ARG_LIST: commandType[],
   SCRIPT_CONFIG_MAP: ConfigMap,
 ): IScene => {
-  const rawSentenceList = rawScene.split('\n'); // 原始句子列表
+  const rawSentenceList = rawScene.replaceAll('\r', '').split('\n'); // 原始句子列表
 
   // 去分号留到后面去做了，现在注释要单独处理
   const rawSentenceListWithoutEmpty = rawSentenceList;

package/src/scriptParser/argsParser.ts

@@ -23,10 +23,10 @@ export function argsParser(
   });
   rawArgsList.forEach((e) => {
     const equalSignIndex = e.indexOf('=');
-    let argName = e.slice(0, equalSignIndex);
-    let argValue: string | undefined = e.slice(equalSignIndex + 1);
+    let argName = e.slice(0, equalSignIndex).trim();
+    let argValue: string | undefined = e.slice(equalSignIndex + 1).trim();
     if (equalSignIndex < 0) {
-      argName = e;
+      argName = e.trim();
       argValue = undefined;
     }
     // 判断是不是语音参数

package/src/scriptParser/scriptParser.ts

@@ -36,14 +36,16 @@ export const scriptParser = (
   // 正式开始解析
 
   // 去分号
-  let newSentenceRaw = sentenceRaw.split(/(?<!\\);/)[0];
+  const commentSplit = sentenceRaw.split(/(?<!\\);/);
+  let newSentenceRaw = commentSplit[0];
   newSentenceRaw = newSentenceRaw.replaceAll('\\;',';');
-  if (newSentenceRaw === '') {
+  const sentenceComment = commentSplit[1] ?? '';
+  if (newSentenceRaw.trim() === '') {
     // 注释提前返回
     return {
       command: commandType.comment, // 语句类型
       commandRaw: 'comment', // 命令原始内容，方便调试
-      content: sentenceRaw.split(';')[1] ?? '', // 语句内容
+      content: sentenceComment.trim(), // 语句内容
       args: [{ key: 'next', value: true }], // 参数列表
       sentenceAssets: [], // 语句携带的资源列表
       subScene: [], // 语句携带的子场景