kipphi 2.1.0 → 2.1.2-rc.1

package/README.md

@@ -1,7 +1,14 @@
+# 用“奇谱”谱面内核将谱面解析为编辑器友好的格式！
+这是一个Phigros KPA、RPE谱面的解析器兼谱面操作系统。它是[KPA（奇谱发生器）](https://github.com/TeamZincs/KPA)的子项目。
+
+“奇谱”来自荷兰化学家启普，他发明了“启普发生器”，用于生产气体并随时停止反应。
+
+在(Phigros 自制谱Wiki)[https://pgrfm.miraheze.org/wiki]了解更多。
+
 # Parse your chart into an editor-friendly format with Kipphi!
 
-This is a Phigros KipphiApparatus/Re:PhiEdit ChartJSON Parser. It is a subproject of [KPA](https://github.com/TeamZincs/KPA).
+This is a Phigros KipphiApparatus/Re:PhiEdit ChartJSON Parser and Chart Operating System. It is a subproject of [KPA](https://github.com/TeamZincs/KPA).
 
 "Kipphi" comes from the Dutch chemist Kipp, who invented Kipp's Apparatus, which was used to produce gas and stop the reaction at any time.
 
-警告：KPA 2.1版本发布以前均为实验性代码，可能会出现API兼容性问题，当前不建议将此代码用于生产！
+Learn more at [Phigros Custom Chart Wiki](https://pgrfm.miraheze.org/wiki).

package/bpm.ts

@@ -63,6 +63,15 @@ export class BPMEndNode extends EventEndNode {
     override previous: BPMStartNode;
     /** 下一个BPM起始节点 */
     override next: BPMStartNode;
+
+    // @ts-expect-error 强加一个getter
+    get value(): number {
+        return this.previous.value;
+    }
+    set value(value: number) {
+        if (!this.previous) { return; }
+        this.previous.value = value;
+    }
     
     /**
      * 创建一个新的BPM结束节点

package/env.ts

@@ -53,6 +53,7 @@ export enum ERROR_IDS {
     SEQUENCE_NODE_TIME_OCCUPIED =                   ENS        | OCCPIED       | 1,
     INVALID_EVENT_NODE_SEQUENCE_TYPE =              ENS        | INVALID_DATA  | 0,
     EVENT_NODE_TIME_NOT_INCREMENTAL =               ENS        | INVALID_DATA  | 1,
+    EVENT_NODE_NOT_DENSE =                          ENS        | INVALID_DATA  | 2,
     PARENT_SEQUENCE_NOT_FOUND =                     ENS        | INVALID_USAGE | 1,
     NEEDS_AT_LEAST_ONE_ENS =                        ENS        | INVALID_USAGE | 2,
     SEQUENCE_TYPE_NOT_CONSISTENT =                  ENS        | INVALID_USAGE | 3,
@@ -175,9 +176,37 @@ export const ERRORS = {
         `Parametric Macro requires key. At ${pos}`,
     MACRO_NOT_PARAMETRIC: (macroId: string, pos) =>
         `Macro '${macroId}' is not parametric. At ${pos}`,
+    EVENT_NODE_NOT_DENSE: (pos: string) =>
+        `EventNode is not dense. At ${pos}`,
 } satisfies Record<keyof typeof ERROR_IDS, (...args: any[]) => string>
 
+type EnumKeys<E extends Record<string, string | number>> = E[keyof E];
+
+// 工具类型：检查 T 的键是否恰好等于枚举的值集合
+type AssertExactEnumKeys<T, E extends Record<string, string | number>> =
+  // 1. 收集 T 的键（作为字符串字面量类型）
+  (keyof T) extends (keyof E)            // 不能有多余键
+    ? (keyof E) extends (keyof T)        // 不能缺键
+      ? T                                   // 通过检查
+      : { error: any/*error: "Interface is missing some enum keys"*/ }
+    : { error: "Interface has extra keys not in enum" };
+
+// 用类型别名做“编译期断言”
+type _CheckMap = AssertExactEnumKeys<ErrorMap, typeof ERROR_IDS>;
+interface _Error extends _CheckMap {
+    error: "";
+}
+
+
+interface ErrorMap extends Record<keyof typeof ERROR_IDS, Array<any>>{
+    EVENT_NODE_NOT_DENSE: [EventNode];
+}
+
+type ArgsOf<ET extends ERROR_IDS> = ET extends keyof ErrorMap ? ErrorMap[ET] : never;
+
 export class KPAError<ET extends ERROR_IDS> extends Error {
+    fixed = false;
+    args: ArgsOf<ET> | [];
     constructor(message: string, public id: ET) {
         super(message);
     }
@@ -186,8 +215,15 @@ export class KPAError<ET extends ERROR_IDS> extends Error {
      * 
      * 此时可以调用该方法，该方法会输出错误并把它保存到KPAError的一个`buffer`静态属性下。
      */
-    warn() {
+    warn(...args: ArgsOf<ET> | []) {
         console.warn(this.stack);
+        this.args = args;
+        KPAError.buffer.push(this);
+    }
+    fix(...args: ArgsOf<ET> | []) {
+        console.warn("[Auto Fixed]" + this.stack);
+        this.fixed = true;
+        this.args = args;
         KPAError.buffer.push(this);
     }
     static buffer: KPAError<ERROR_IDS>[] = [];

package/event.ts

@@ -505,7 +505,7 @@ export class EventNodeSequence<VT extends EventValueESType = number> { // 泛型
         return type === EventType.speed                               ? 10  :
                type === EventType.scaleX || type === EventType.scaleY ? 1.0 :
                type === EventType.text                                ? ""  :
-               type === EventType.color                               ? [0, 0, 0] :
+               type === EventType.color                               ? [255, 255, 255] :
                0
     }
     /**
@@ -649,32 +649,28 @@ export class EventNodeSequence<VT extends EventValueESType = number> { // 泛型
                 err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}] and the previous`).warn()
             }
             if (!TC.lt(event.startTime, event.endTime)) {
-                err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}]`).warn()
+                if (TC.eq(event.startTime, event.endTime)) {
+                    // 零长事件直接忽略，并认为已经修复
+                    err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}]`).fix();
+                    continue;
+                } else {
+                    err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}]`).warn()
+                }
             }
-            lastEndTime = event.endTime;
             if (lastEnd.type === NodeType.HEAD) {
                 EventNode.connect(lastEnd, start)
-            // 如果上一个是钩定事件，那么一块捋平
-            } else if (
-                   lastEnd.value === lastEnd.previous.value
-                && lastEnd.previous.evaluator instanceof EasedEvaluator
-            ) {
-                lastEnd.time = start.time
-                EventNode.connect(lastEnd, start)
-            } else if (TC.eq(lastEnd.time, start.time)) {
-                const val = lastEnd.value;
-                const midStart = new EventStartNode(lastEnd.time, val);
-                const midEnd = new EventEndNode(start.time, val);
-                midStart.evaluator = lastEnd.previous.evaluator;
-                EventNode.connect(lastEnd, midStart);
-                EventNode.connect(midStart, midEnd);
+            } else if (TC.gt(event.startTime, lastEndTime)) {
+                err.EVENT_NODE_NOT_DENSE(`${pos}.events[${index}]`).warn();
+                const mid = new EventStartNode(lastEndTime, start.value);
+                const midEnd = new EventEndNode(event.startTime, end.value);
+                EventNode.connect(lastEnd, mid);
+                EventNode.connect(mid, midEnd);
                 EventNode.connect(midEnd, start);
-                listLength++;
             } else {
-                
                 EventNode.connect(lastEnd, start)
             }
             
+            lastEndTime = event.endTime;
             lastEnd = end;
         }
         const last = lastEnd;
@@ -948,6 +944,29 @@ export class EventNodeSequence<VT extends EventValueESType = number> { // 泛型
         dest.initJump();
         return dest;
     }
+    checkErrors() {
+        let currentNode: EventStartNode<VT> = this.head.next;
+        if (TC.ne(currentNode.time, [0, 0, 1])) {
+            err.EVENT_NODE_NOT_DENSE(`${this.id}, ${currentNode.time}`).fix();
+            currentNode.time = [0, 0, 1];
+        }
+        const endNode = currentNode.next;
+        if (endNode.type === NodeType.TAIL) {
+            return;
+        }
+
+        let lastEnd: EventEndNode<VT> = endNode;
+        while (true) {
+            const endNode = currentNode.next;
+            if (endNode.type === NodeType.TAIL) {
+                break;
+            }
+            if (TC.ne(lastEnd.time, currentNode.time)) {
+                err.EVENT_NODE_NOT_DENSE(`${this.id}, ${currentNode.time}`).warn();
+            }
+            currentNode = currentNode.next.next;
+        }
+    }
 }
 
 export type SpeedENS = EventNodeSequence<number> & { type: EventType.speed };

package/index.d.ts

@@ -533,7 +533,7 @@ declare module "chartTypes" {
     export type ExtendedEventTypeName = "scaleX" | "scaleY" | "text" | "color";
 }
 declare module "version" {
-    export const VERSION = 210;
+    export const VERSION = 212;
     export const SCHEMA = "https://cdn.jsdelivr.net/npm/kipphi@2.1.0/chartType2.schema.json";
 }
 declare module "util" {
@@ -652,6 +652,8 @@ declare module "bpm" {
         previous: BPMStartNode;
         /** 下一个BPM起始节点 */
         next: BPMStartNode;
+        get value(): number;
+        set value(value: number);
         /**
          * 创建一个新的BPM结束节点
          * @param endTime 节点结束时间
@@ -2179,6 +2181,7 @@ declare module "event" {
          * @throws {KPAError<ERROR_IDS.NEEDS_AT_LEAST_ONE_ENS>}
          */
         static mergeSequences(sequences: EventNodeSequence[]): EventNodeSequence<number>;
+        checkErrors(): void;
     }
     export type SpeedENS = EventNodeSequence<number> & {
         type: EventType.speed;
@@ -2186,12 +2189,14 @@ declare module "event" {
 }
 declare module "env" {
     import { type TimeT, type EventValueType } from "chartTypes";
+    import { EventNode } from "event";
     export enum ERROR_IDS {
         UI_OCCUPIED = 272,
         SEQUENCE_NAME_OCCUPIED = 1552,
         SEQUENCE_NODE_TIME_OCCUPIED = 1553,
         INVALID_EVENT_NODE_SEQUENCE_TYPE = 1568,
         EVENT_NODE_TIME_NOT_INCREMENTAL = 1569,
+        EVENT_NODE_NOT_DENSE = 1570,
         PARENT_SEQUENCE_NOT_FOUND = 1585,
         NEEDS_AT_LEAST_ONE_ENS = 1586,
         SEQUENCE_TYPE_NOT_CONSISTENT = 1587,
@@ -2255,16 +2260,24 @@ declare module "env" {
         JAVASCRIPT_SYNTAX_ERROR: (error: Error, macroId: string) => string;
         PARAMETRIC_MACRO_REQUIRES_PROTO_KEY: (pos: any) => string;
         MACRO_NOT_PARAMETRIC: (macroId: string, pos: any) => string;
+        EVENT_NODE_NOT_DENSE: (pos: string) => string;
     };
+    interface ErrorMap extends Record<keyof typeof ERROR_IDS, Array<any>> {
+        EVENT_NODE_NOT_DENSE: [EventNode];
+    }
+    type ArgsOf<ET extends ERROR_IDS> = ET extends keyof ErrorMap ? ErrorMap[ET] : never;
     export class KPAError<ET extends ERROR_IDS> extends Error {
         id: ET;
+        fixed: boolean;
+        args: ArgsOf<ET> | [];
         constructor(message: string, id: ET);
         /**
          * 对于解析谱面等场景，有时可能需要找出全部的错误，不宜直接抛出错误中断代码执行
          *
          * 此时可以调用该方法，该方法会输出错误并把它保存到KPAError的一个`buffer`静态属性下。
          */
-        warn(): void;
+        warn(...args: ArgsOf<ET> | []): void;
+        fix(...args: ArgsOf<ET> | []): void;
         static buffer: KPAError<ERROR_IDS>[];
         static flush(): void;
     }
@@ -2311,6 +2324,7 @@ declare module "env" {
             JAVASCRIPT_SYNTAX_ERROR: (error: Error, macroId: string) => KPAError<ERROR_IDS.JAVASCRIPT_SYNTAX_ERROR>;
             PARAMETRIC_MACRO_REQUIRES_PROTO_KEY: (pos: any) => KPAError<ERROR_IDS.PARAMETRIC_MACRO_REQUIRES_PROTO_KEY>;
             MACRO_NOT_PARAMETRIC: (macroId: string, pos: any) => KPAError<ERROR_IDS.MACRO_NOT_PARAMETRIC>;
+            EVENT_NODE_NOT_DENSE: (pos: string) => KPAError<ERROR_IDS.EVENT_NODE_NOT_DENSE>;
         };
         freeze(): void;
     };

package/index.js

@@ -60,6 +60,7 @@ var ERROR_IDS;
   ERROR_IDS2[ERROR_IDS2["SEQUENCE_NODE_TIME_OCCUPIED"] = ENS | OCCPIED | 1] = "SEQUENCE_NODE_TIME_OCCUPIED";
   ERROR_IDS2[ERROR_IDS2["INVALID_EVENT_NODE_SEQUENCE_TYPE"] = ENS | INVALID_DATA | 0] = "INVALID_EVENT_NODE_SEQUENCE_TYPE";
   ERROR_IDS2[ERROR_IDS2["EVENT_NODE_TIME_NOT_INCREMENTAL"] = ENS | INVALID_DATA | 1] = "EVENT_NODE_TIME_NOT_INCREMENTAL";
+  ERROR_IDS2[ERROR_IDS2["EVENT_NODE_NOT_DENSE"] = ENS | INVALID_DATA | 2] = "EVENT_NODE_NOT_DENSE";
   ERROR_IDS2[ERROR_IDS2["PARENT_SEQUENCE_NOT_FOUND"] = ENS | INVALID_USAGE | 1] = "PARENT_SEQUENCE_NOT_FOUND";
   ERROR_IDS2[ERROR_IDS2["NEEDS_AT_LEAST_ONE_ENS"] = ENS | INVALID_USAGE | 2] = "NEEDS_AT_LEAST_ONE_ENS";
   ERROR_IDS2[ERROR_IDS2["SEQUENCE_TYPE_NOT_CONSISTENT"] = ENS | INVALID_USAGE | 3] = "SEQUENCE_TYPE_NOT_CONSISTENT";
@@ -122,17 +123,27 @@ var ERRORS = {
   PROTO_PRESENT_IN_NONPARAMETRIC: (macroId) => `'@proto can only be used in parametric Macros. At ${macroId}'`,
   JAVASCRIPT_SYNTAX_ERROR: (error, macroId) => `JavaScript Syntax Error: ${error.message}. At ${macroId}`,
   PARAMETRIC_MACRO_REQUIRES_PROTO_KEY: (pos) => `Parametric Macro requires key. At ${pos}`,
-  MACRO_NOT_PARAMETRIC: (macroId, pos) => `Macro '${macroId}' is not parametric. At ${pos}`
+  MACRO_NOT_PARAMETRIC: (macroId, pos) => `Macro '${macroId}' is not parametric. At ${pos}`,
+  EVENT_NODE_NOT_DENSE: (pos) => `EventNode is not dense. At ${pos}`
 };
 
 class KPAError extends Error {
   id;
+  fixed = false;
+  args;
   constructor(message, id) {
     super(message);
     this.id = id;
   }
-  warn() {
+  warn(...args) {
     console.warn(this.stack);
+    this.args = args;
+    KPAError.buffer.push(this);
+  }
+  fix(...args) {
+    console.warn("[Auto Fixed]" + this.stack);
+    this.fixed = true;
+    this.args = args;
     KPAError.buffer.push(this);
   }
   static buffer = [];
@@ -1643,7 +1654,7 @@ class EventNodeSequence {
     this.listLength = 1;
   }
   static getDefaultValueFromEventType(type) {
-    return type === 4 /* speed */ ? 10 : type === 7 /* scaleX */ || type === 8 /* scaleY */ ? 1 : type === 9 /* text */ ? "" : type === 10 /* color */ ? [0, 0, 0] : 0;
+    return type === 4 /* speed */ ? 10 : type === 7 /* scaleX */ || type === 8 /* scaleY */ ? 1 : type === 9 /* text */ ? "" : type === 10 /* color */ ? [255, 255, 255] : 0;
   }
   static fromRPEJSON(type, data, chart, pos, endValue) {
     const { templateEasingLib: templates } = chart;
@@ -1723,26 +1734,26 @@ class EventNodeSequence {
         err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}] and the previous`).warn();
       }
       if (!TC2.lt(event.startTime, event.endTime)) {
-        err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}]`).warn();
+        if (TC2.eq(event.startTime, event.endTime)) {
+          err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}]`).fix();
+          continue;
+        } else {
+          err.EVENT_NODE_TIME_NOT_INCREMENTAL(`${pos}.events[${index}]`).warn();
+        }
       }
-      lastEndTime = event.endTime;
       if (lastEnd.type === 0 /* HEAD */) {
         EventNode.connect(lastEnd, start);
-      } else if (lastEnd.value === lastEnd.previous.value && lastEnd.previous.evaluator instanceof EasedEvaluator) {
-        lastEnd.time = start.time;
-        EventNode.connect(lastEnd, start);
-      } else if (TC2.eq(lastEnd.time, start.time)) {
-        const val = lastEnd.value;
-        const midStart = new EventStartNode(lastEnd.time, val);
-        const midEnd = new EventEndNode(start.time, val);
-        midStart.evaluator = lastEnd.previous.evaluator;
-        EventNode.connect(lastEnd, midStart);
-        EventNode.connect(midStart, midEnd);
+      } else if (TC2.gt(event.startTime, lastEndTime)) {
+        err.EVENT_NODE_NOT_DENSE(`${pos}.events[${index}]`).warn();
+        const mid = new EventStartNode(lastEndTime, start.value);
+        const midEnd = new EventEndNode(event.startTime, end.value);
+        EventNode.connect(lastEnd, mid);
+        EventNode.connect(mid, midEnd);
         EventNode.connect(midEnd, start);
-        listLength++;
       } else {
         EventNode.connect(lastEnd, start);
       }
+      lastEndTime = event.endTime;
       lastEnd = end;
     }
     const last = lastEnd;
@@ -1945,6 +1956,28 @@ class EventNodeSequence {
     dest.initJump();
     return dest;
   }
+  checkErrors() {
+    let currentNode = this.head.next;
+    if (TC2.ne(currentNode.time, [0, 0, 1])) {
+      err.EVENT_NODE_NOT_DENSE(`${this.id}, ${currentNode.time}`).fix();
+      currentNode.time = [0, 0, 1];
+    }
+    const endNode = currentNode.next;
+    if (endNode.type === 1 /* TAIL */) {
+      return;
+    }
+    let lastEnd = endNode;
+    while (true) {
+      const endNode2 = currentNode.next;
+      if (endNode2.type === 1 /* TAIL */) {
+        break;
+      }
+      if (TC2.ne(lastEnd.time, currentNode.time)) {
+        err.EVENT_NODE_NOT_DENSE(`${this.id}, ${currentNode.time}`).warn();
+      }
+      currentNode = currentNode.next.next;
+    }
+  }
 }
 // src/note.ts
 var notePropTypes = {
@@ -2007,7 +2040,7 @@ class Note {
     return note;
   }
   computeVisibleBeats(timeCalculator) {
-    if (!this.visibleTime || this.visibleTime >= 90000) {
+    if (this.visibleTime === undefined || this.visibleTime === null || this.visibleTime >= 90000) {
       this.visibleBeats = Infinity;
       return;
     }
@@ -3033,6 +3066,15 @@ class BPMEndNode extends EventEndNode {
   spb;
   previous;
   next;
+  get value() {
+    return this.previous.value;
+  }
+  set value(value) {
+    if (!this.previous) {
+      return;
+    }
+    this.previous.value = value;
+  }
   constructor(endTime) {
     super(endTime, null);
   }
@@ -3167,7 +3209,7 @@ class TimeCalculator {
   }
 }
 // src/version.ts
-var VERSION = 210;
+var VERSION = 212;
 var SCHEMA = "https://cdn.jsdelivr.net/npm/kipphi@2.1.0/chartType2.schema.json";
 
 // src/chart.ts
@@ -3803,9 +3845,10 @@ class OperationList extends EventTarget {
       this.dispatchEvent(new OperationErrorEvent(operation, e));
       return;
     }
+    this.undoneOperations = [];
+    this.operations.push(operation);
     this.dispatchEvent(new OperationEvent("do", operation));
     this.processFlags(operation);
-    this.operations.push(operation);
   }
   processFlags(operation) {
     if (operation.updatesEditor) {

package/note.ts

@@ -120,7 +120,7 @@ export class Note {
         return note;
     }
     computeVisibleBeats(timeCalculator: TimeCalculator) {
-        if (!this.visibleTime || this.visibleTime >= 90000) {
+        if (this.visibleTime === undefined || this.visibleTime === null || this.visibleTime >= 90000) {
             this.visibleBeats = Infinity;
             return;
         }

package/operation/basic.ts

@@ -147,9 +147,10 @@ export class OperationList extends EventTarget {
             this.dispatchEvent(new OperationErrorEvent(operation, e as Error))
             return
         }
+        this.undoneOperations = [];
+        this.operations.push(operation);
         this.dispatchEvent(new OperationEvent("do", operation));
         this.processFlags(operation);
-        this.operations.push(operation);
     }
     processFlags(operation: Operation) {
 

package/package.json

@@ -1,26 +1,26 @@
 {
-  "name": "kipphi",
-  "description": "Parse your Phigros Chart(.rpe.json or .kpa.json) into an editor-friendly format.",
-  "version": "2.1.0",
-  "author": "Team Zincs (https://github.com/TeamZincs)",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/TeamZincs/kipphi.git"
-  },
-  "module": "index.ts",
-  "main": "index.ts",
-  "type": "module",
-  "devDependencies": {
-    "@types/bun": "latest"
-  },
-  "peerDependencies": {
-    "typescript": "^5"
-  },
-  "exports": {
-    "./operation": null,
-    ".": {
-      "import": "./index.ts"
+    "name": "kipphi",
+    "description": "Parse your Phigros Chart(.rpe.json or .kpa.json) into an editor-friendly format.",
+    "version": "2.1.2-rc.1",
+    "author": "Team Zincs (https://github.com/TeamZincs)",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/TeamZincs/kipphi.git"
+    },
+    "module": "index.ts",
+    "main": "index.ts",
+    "type": "module",
+    "devDependencies": {
+        "@types/bun": "latest"
+    },
+    "peerDependencies": {
+        "typescript": "^5"
+    },
+    "exports": {
+        "./operation": null,
+        ".": {
+            "import": "./index.ts"
+        }
     }
-  }
 }

package/version.ts

@@ -2,7 +2,7 @@
 
 /// #declaration:global
 
-export const VERSION = 210;
+export const VERSION = 212;
 export const SCHEMA = "https://cdn.jsdelivr.net/npm/kipphi@2.1.0/chartType2.schema.json"