@lingfan-engine/editor 0.1.0 → 0.1.2

package/src/schema/opSchemas/map.ts

@@ -1,134 +1,134 @@
-import { z } from "zod";
-import {
-  saySchema,
-  menuSchema,
-  inputSchema,
-  notifySchema,
-  nvlSchema,
-  characterSchema,
-  uncharacterSchema,
-  waitSchema,
-  pauseSchema,
-  randomSchema,
-  jumpSchema,
-  navigateSchema,
-  funcSchema,
-  callSchema,
-  returnSchema,
-  ifSchema,
-  whileSchema,
-  forSchema,
-  foreachSchema,
-  switchSchema,
-  emptySchema,
-  assertSchema,
-  guardSchema,
-  assignSchema,
-  undefSchema,
-  arraySchema,
-  arrayPushSchema,
-  arrayPopSchema,
-  dictSchema,
-  dictSetSchema,
-  saveSchema,
-  loadSchema,
-  autoSaveSchema,
-  saveDeleteSchema,
-  bgmSchema,
-  stopSchema,
-  seSchema,
-  voiceSchema,
-  videoSchema,
-  cutsceneSchema,
-  seekVideoSchema,
-  videoSkipableSchema,
-  minigameSchema,
-  interactionSchema,
-  showSchema,
-  hideSchema,
-  backgroundSchema,
-  bgSwitchSchema,
-  zindexSchema,
-  styleSchema,
-  windowSchema,
-  animateSchema,
-  animateBlockSchema,
-  transitionSchema,
-  shakeSchema,
-  textTypewriterSchema,
-} from "./commands.ts";
-
-/** op → 负载 schema（不含 op 键本身）；字面量键形态 = `ScriptCommand` 判别联合的派生源。
- * 新增 op = 加条目 = 表单 / 校验 / 类型三面自动出现（单一事实源，零重复定义） */
-export const OP_SCHEMA_MAP = {
-  say: saySchema,
-  menu: menuSchema,
-  input: inputSchema,
-  notify: notifySchema,
-  nvl: nvlSchema,
-  character: characterSchema,
-  uncharacter: uncharacterSchema,
-  wait: waitSchema,
-  pause: pauseSchema,
-  random: randomSchema,
-  jump: jumpSchema,
-  navigate: navigateSchema,
-  func: funcSchema,
-  call: callSchema,
-  return: returnSchema,
-  if: ifSchema,
-  while: whileSchema,
-  for: forSchema,
-  foreach: foreachSchema,
-  switch: switchSchema,
-  break: emptySchema,
-  continue: emptySchema,
-  assert: assertSchema,
-  guard: guardSchema,
-  set: assignSchema,
-  define: assignSchema,
-  let: assignSchema,
-  local: assignSchema,
-  undef: undefSchema,
-  array: arraySchema,
-  array_push: arrayPushSchema,
-  array_pop: arrayPopSchema,
-  dict: dictSchema,
-  dict_set: dictSetSchema,
-  save: saveSchema,
-  load: loadSchema,
-  auto_save: autoSaveSchema,
-  save_delete: saveDeleteSchema,
-  bgm: bgmSchema,
-  stop_bgm: stopSchema,
-  se: seSchema,
-  ambient: bgmSchema,
-  stop_ambient: stopSchema,
-  voice: voiceSchema,
-  stop_voice: stopSchema,
-  video: videoSchema,
-  cutscene: cutsceneSchema,
-  seek_video: seekVideoSchema,
-  pause_video: emptySchema,
-  resume_video: emptySchema,
-  stop_video: emptySchema,
-  video_skipable: videoSkipableSchema,
-  minigame: minigameSchema,
-  interaction: interactionSchema,
-  // 元素系统
-  show: showSchema,
-  hide: hideSchema,
-  background: backgroundSchema,
-  bg_switch: bgSwitchSchema,
-  zindex: zindexSchema,
-  style: styleSchema,
-  window: windowSchema,
-  animate: animateSchema,
-  animate_block: animateBlockSchema,
-  transition: transitionSchema,
-  shake: shakeSchema,
-  text_typewriter: textTypewriterSchema,
-};
-
-/** 运行期查找面（与 `OP_SCHEMA_MAP` 同一对象，键集恒等）；新增 op 自动可用 */
-export const OP_SCHEMAS: Readonly<Record<string, z.ZodType>> = OP_SCHEMA_MAP;
+import { z } from "zod";
+import {
+  saySchema,
+  menuSchema,
+  inputSchema,
+  notifySchema,
+  nvlSchema,
+  characterSchema,
+  uncharacterSchema,
+  waitSchema,
+  pauseSchema,
+  randomSchema,
+  jumpSchema,
+  navigateSchema,
+  funcSchema,
+  callSchema,
+  returnSchema,
+  ifSchema,
+  whileSchema,
+  forSchema,
+  foreachSchema,
+  switchSchema,
+  emptySchema,
+  assertSchema,
+  guardSchema,
+  assignSchema,
+  undefSchema,
+  arraySchema,
+  arrayPushSchema,
+  arrayPopSchema,
+  dictSchema,
+  dictSetSchema,
+  saveSchema,
+  loadSchema,
+  autoSaveSchema,
+  saveDeleteSchema,
+  bgmSchema,
+  stopSchema,
+  seSchema,
+  voiceSchema,
+  videoSchema,
+  cutsceneSchema,
+  seekVideoSchema,
+  videoSkipableSchema,
+  minigameSchema,
+  interactionSchema,
+  showSchema,
+  hideSchema,
+  backgroundSchema,
+  bgSwitchSchema,
+  zindexSchema,
+  styleSchema,
+  windowSchema,
+  animateSchema,
+  animateBlockSchema,
+  transitionSchema,
+  shakeSchema,
+  textTypewriterSchema,
+} from "./commands.ts";
+
+/** op → 负载 schema（不含 op 键本身）；字面量键形态 = `ScriptCommand` 判别联合的派生源。
+ * 新增 op = 加条目 = 表单 / 校验 / 类型三面自动出现（单一事实源，零重复定义） */
+export const OP_SCHEMA_MAP = {
+  say: saySchema,
+  menu: menuSchema,
+  input: inputSchema,
+  notify: notifySchema,
+  nvl: nvlSchema,
+  character: characterSchema,
+  uncharacter: uncharacterSchema,
+  wait: waitSchema,
+  pause: pauseSchema,
+  random: randomSchema,
+  jump: jumpSchema,
+  navigate: navigateSchema,
+  func: funcSchema,
+  call: callSchema,
+  return: returnSchema,
+  if: ifSchema,
+  while: whileSchema,
+  for: forSchema,
+  foreach: foreachSchema,
+  switch: switchSchema,
+  break: emptySchema,
+  continue: emptySchema,
+  assert: assertSchema,
+  guard: guardSchema,
+  set: assignSchema,
+  define: assignSchema,
+  let: assignSchema,
+  local: assignSchema,
+  undef: undefSchema,
+  array: arraySchema,
+  array_push: arrayPushSchema,
+  array_pop: arrayPopSchema,
+  dict: dictSchema,
+  dict_set: dictSetSchema,
+  save: saveSchema,
+  load: loadSchema,
+  auto_save: autoSaveSchema,
+  save_delete: saveDeleteSchema,
+  bgm: bgmSchema,
+  stop_bgm: stopSchema,
+  se: seSchema,
+  ambient: bgmSchema,
+  stop_ambient: stopSchema,
+  voice: voiceSchema,
+  stop_voice: stopSchema,
+  video: videoSchema,
+  cutscene: cutsceneSchema,
+  seek_video: seekVideoSchema,
+  pause_video: emptySchema,
+  resume_video: emptySchema,
+  stop_video: emptySchema,
+  video_skipable: videoSkipableSchema,
+  minigame: minigameSchema,
+  interaction: interactionSchema,
+  // 元素系统
+  show: showSchema,
+  hide: hideSchema,
+  background: backgroundSchema,
+  bg_switch: bgSwitchSchema,
+  zindex: zindexSchema,
+  style: styleSchema,
+  window: windowSchema,
+  animate: animateSchema,
+  animate_block: animateBlockSchema,
+  transition: transitionSchema,
+  shake: shakeSchema,
+  text_typewriter: textTypewriterSchema,
+};
+
+/** 运行期查找面（与 `OP_SCHEMA_MAP` 同一对象，键集恒等）；新增 op 自动可用 */
+export const OP_SCHEMAS: Readonly<Record<string, z.ZodType>> = OP_SCHEMA_MAP;

package/src/schema/opSchemas/validate.ts

@@ -1,184 +1,184 @@
-/**
- * 编辑期 fail-closed 校验执行：把 zod issue 翻译为中文人话诊断（未知 op /
- * 未知字段 / 缺必填 / 类型错），供 `validateStory` 与属性面板实时校验共用。
- */
-import { z } from "zod";
-import type { Diagnostic, EditorTexts } from "../../contracts/index.ts";
-import { escapePointerToken, resolveEditorTexts } from "../../contracts/index.ts";
-import { OP_SCHEMAS } from "./map.ts";
-
-/**
- * **「resource 为空」时该用哪个停止命令**。
- *
- * 为什么需要：既有工程里有 `bgm ""` 表「停止 BGM」的写法，而播放器对空路径
- * **无特判**（直接以空串去加载）⇒ **静默失败**——作者以为停了，其实没有。
- * 显式报错比「静默通过」更正确，但直接抛 zod 英文原话
- * （`Too small: expected string to have >=1 characters`）作者既看不懂、
- * 也不知道该改什么。
- *
- * 处置 = **保持严格校验**（不引入「空路径=停止」这种隐式约定）
- * + **把正确写法直接告诉作者**（语义明确）。
- */
-const STOP_OP_BY_RESOURCE_OWNER: Readonly<Record<string, string>> = {
-  bgm: "stop_bgm",
-  ambient: "stop_ambient",
-  voice: "stop_voice",
-  video: "stop_video",
-  cutscene: "stop_video",
-};
-
-/**
- * zod 错误 → **中文人话**（编辑期诊断给作者看，不该直接透传英文）。
- *
- * **兜底保留原文**：没覆盖的 code 返回 `issue.message`——
- * 宁可英文也不静默丢信息（不吞信息）。
- *
- * 文案经 EditorTexts 表（本模块是唯一 zod→中文翻译点；表方法由本函数调用）。
- */
-function localizeZodIssue(
-  op: string,
-  issue: z.core.$ZodIssue,
-  texts: EditorTexts,
-): string {
-  const field = issue.path.map(String).join(".");
-  const at = field === "" ? "" : `${field} `;
-  switch (issue.code) {
-    case "too_small": {
-      const min = (issue as { minimum?: number }).minimum;
-      if (field === "resource" || field.endsWith(".resource")) {
-        const stopOp = STOP_OP_BY_RESOURCE_OWNER[op];
-        return stopOp === undefined
-          ? texts.resourcePathEmpty()
-          : texts.resourcePathEmptyStop(stopOp);
-      }
-      return typeof min === "number" && min > 0
-        ? texts.valueTooSmall(at, min)
-        : texts.valueTooSmallBare(at);
-    }
-    case "too_big": {
-      const max = (issue as { maximum?: number }).maximum;
-      return typeof max === "number"
-        ? texts.valueTooBig(at, max)
-        : texts.valueTooBigBare(at);
-    }
-    case "invalid_type": {
-      const expected = (issue as { expected?: unknown }).expected;
-      return texts.invalidType(at, typeof expected === "string" ? expected : "");
-    }
-    case "invalid_format": {
-      const format = (issue as { format?: unknown }).format;
-      return texts.invalidFormat(at, typeof format === "string" ? format : "");
-    }
-    default:
-      return issue.message;
-  }
-}
-
-function issueToDiagnostic(
-  issue: z.core.$ZodIssue,
-  basePointer: string,
-  op: string,
-  texts: EditorTexts,
-): Diagnostic {
-  const segments = issue.path.map((seg) => escapePointerToken(String(seg)));
-  const pointer =
-    segments.length > 0 ? `${basePointer}/${segments.join("/")}` : basePointer;
-  if (issue.code === "unrecognized_keys") {
-    const keys =
-      "keys" in issue && Array.isArray(issue.keys)
-        ? issue.keys.map(String).join(", ")
-        : issue.message;
-    return {
-      code: "unknown-field",
-      severity: "error",
-      message: texts.unknownPayloadFields(op, keys),
-      pointer,
-      op,
-    };
-  }
-  const received = (issue as { received?: unknown }).received;
-  if (
-    issue.code === "invalid_type" &&
-    (received === undefined || received === "undefined")
-  ) {
-    return {
-      code: "missing-required",
-      severity: "error",
-      message: texts.missingRequired(
-        op,
-        issue.path.length > 0 ? issue.path.join(".") : "",
-      ),
-      pointer,
-      op,
-    };
-  }
-  return {
-    code: "invalid-value",
-    severity: "error",
-    message: texts.invalidValue(
-      op,
-      issue.path.length > 0 ? issue.path.join(".") : "",
-      localizeZodIssue(op, issue, texts),
-    ),
-    pointer,
-    op,
-  };
-}
-
-/**
- * 编辑期单命令 fail-closed 校验（结构层）：未知 op / 未知字段 / 缺必填 / 类型错。
- * pointer = 命令对象自身在 Story 树上的 JSON Pointer。
- * `schemas`（可选）= op 负载 schema 面（缺省内建 OP_SCHEMAS；扩展注册后传合并集）。
- * `texts`（可选）= 集中文案表注入（缺省 defaultEditorTexts）。
- * 编辑期 fail-closed 校验的测试见 validation.test。
- */
-export function validateCommand(
-  cmd: unknown,
-  pointer = "",
-  schemas: Readonly<Record<string, z.ZodType>> = OP_SCHEMAS,
-  texts: Partial<EditorTexts> = {},
-): Diagnostic[] {
-  const t = resolveEditorTexts(texts);
-  if (typeof cmd !== "object" || cmd === null || Array.isArray(cmd)) {
-    return [
-      {
-        code: "invalid-structure",
-        severity: "error",
-        message: t.commandMustBeObject(),
-        pointer,
-      },
-    ];
-  }
-  const op = (cmd as Record<string, unknown>).op;
-  if (typeof op !== "string" || op === "") {
-    return [
-      {
-        code: "invalid-structure",
-        severity: "error",
-        message: t.commandMustHaveOp(),
-        pointer,
-      },
-    ];
-  }
-  const schema = schemas[op];
-  if (schema === undefined) {
-    return [
-      {
-        code: "unknown-op",
-        severity: "error",
-        message: t.unknownCommand(op),
-        pointer,
-        op,
-      },
-    ];
-  }
-  const payload: Record<string, unknown> = {
-    ...(cmd as Record<string, unknown>),
-  };
-  delete payload.op;
-  const result = schema.safeParse(payload);
-  if (result.success) return [];
-  return result.error.issues.map((issue) =>
-    issueToDiagnostic(issue, pointer, op, t),
-  );
-}
+/**
+ * 编辑期 fail-closed 校验执行：把 zod issue 翻译为中文人话诊断（未知 op /
+ * 未知字段 / 缺必填 / 类型错），供 `validateStory` 与属性面板实时校验共用。
+ */
+import { z } from "zod";
+import type { Diagnostic, EditorTexts } from "../../contracts/index.ts";
+import { escapePointerToken, resolveEditorTexts } from "../../contracts/index.ts";
+import { OP_SCHEMAS } from "./map.ts";
+
+/**
+ * **「resource 为空」时该用哪个停止命令**。
+ *
+ * 为什么需要：既有工程里有 `bgm ""` 表「停止 BGM」的写法，而播放器对空路径
+ * **无特判**（直接以空串去加载）⇒ **静默失败**——作者以为停了，其实没有。
+ * 显式报错比「静默通过」更正确，但直接抛 zod 英文原话
+ * （`Too small: expected string to have >=1 characters`）作者既看不懂、
+ * 也不知道该改什么。
+ *
+ * 处置 = **保持严格校验**（不引入「空路径=停止」这种隐式约定）
+ * + **把正确写法直接告诉作者**（语义明确）。
+ */
+const STOP_OP_BY_RESOURCE_OWNER: Readonly<Record<string, string>> = {
+  bgm: "stop_bgm",
+  ambient: "stop_ambient",
+  voice: "stop_voice",
+  video: "stop_video",
+  cutscene: "stop_video",
+};
+
+/**
+ * zod 错误 → **中文人话**（编辑期诊断给作者看，不该直接透传英文）。
+ *
+ * **兜底保留原文**：没覆盖的 code 返回 `issue.message`——
+ * 宁可英文也不静默丢信息（不吞信息）。
+ *
+ * 文案经 EditorTexts 表（本模块是唯一 zod→中文翻译点；表方法由本函数调用）。
+ */
+function localizeZodIssue(
+  op: string,
+  issue: z.core.$ZodIssue,
+  texts: EditorTexts,
+): string {
+  const field = issue.path.map(String).join(".");
+  const at = field === "" ? "" : `${field} `;
+  switch (issue.code) {
+    case "too_small": {
+      const min = (issue as { minimum?: number }).minimum;
+      if (field === "resource" || field.endsWith(".resource")) {
+        const stopOp = STOP_OP_BY_RESOURCE_OWNER[op];
+        return stopOp === undefined
+          ? texts.resourcePathEmpty()
+          : texts.resourcePathEmptyStop(stopOp);
+      }
+      return typeof min === "number" && min > 0
+        ? texts.valueTooSmall(at, min)
+        : texts.valueTooSmallBare(at);
+    }
+    case "too_big": {
+      const max = (issue as { maximum?: number }).maximum;
+      return typeof max === "number"
+        ? texts.valueTooBig(at, max)
+        : texts.valueTooBigBare(at);
+    }
+    case "invalid_type": {
+      const expected = (issue as { expected?: unknown }).expected;
+      return texts.invalidType(at, typeof expected === "string" ? expected : "");
+    }
+    case "invalid_format": {
+      const format = (issue as { format?: unknown }).format;
+      return texts.invalidFormat(at, typeof format === "string" ? format : "");
+    }
+    default:
+      return issue.message;
+  }
+}
+
+function issueToDiagnostic(
+  issue: z.core.$ZodIssue,
+  basePointer: string,
+  op: string,
+  texts: EditorTexts,
+): Diagnostic {
+  const segments = issue.path.map((seg) => escapePointerToken(String(seg)));
+  const pointer =
+    segments.length > 0 ? `${basePointer}/${segments.join("/")}` : basePointer;
+  if (issue.code === "unrecognized_keys") {
+    const keys =
+      "keys" in issue && Array.isArray(issue.keys)
+        ? issue.keys.map(String).join(", ")
+        : issue.message;
+    return {
+      code: "unknown-field",
+      severity: "error",
+      message: texts.unknownPayloadFields(op, keys),
+      pointer,
+      op,
+    };
+  }
+  const received = (issue as { received?: unknown }).received;
+  if (
+    issue.code === "invalid_type" &&
+    (received === undefined || received === "undefined")
+  ) {
+    return {
+      code: "missing-required",
+      severity: "error",
+      message: texts.missingRequired(
+        op,
+        issue.path.length > 0 ? issue.path.join(".") : "",
+      ),
+      pointer,
+      op,
+    };
+  }
+  return {
+    code: "invalid-value",
+    severity: "error",
+    message: texts.invalidValue(
+      op,
+      issue.path.length > 0 ? issue.path.join(".") : "",
+      localizeZodIssue(op, issue, texts),
+    ),
+    pointer,
+    op,
+  };
+}
+
+/**
+ * 编辑期单命令 fail-closed 校验（结构层）：未知 op / 未知字段 / 缺必填 / 类型错。
+ * pointer = 命令对象自身在 Story 树上的 JSON Pointer。
+ * `schemas`（可选）= op 负载 schema 面（缺省内建 OP_SCHEMAS；扩展注册后传合并集）。
+ * `texts`（可选）= 集中文案表注入（缺省 defaultEditorTexts）。
+ * 编辑期 fail-closed 校验的测试见 validation.test。
+ */
+export function validateCommand(
+  cmd: unknown,
+  pointer = "",
+  schemas: Readonly<Record<string, z.ZodType>> = OP_SCHEMAS,
+  texts: Partial<EditorTexts> = {},
+): Diagnostic[] {
+  const t = resolveEditorTexts(texts);
+  if (typeof cmd !== "object" || cmd === null || Array.isArray(cmd)) {
+    return [
+      {
+        code: "invalid-structure",
+        severity: "error",
+        message: t.commandMustBeObject(),
+        pointer,
+      },
+    ];
+  }
+  const op = (cmd as Record<string, unknown>).op;
+  if (typeof op !== "string" || op === "") {
+    return [
+      {
+        code: "invalid-structure",
+        severity: "error",
+        message: t.commandMustHaveOp(),
+        pointer,
+      },
+    ];
+  }
+  const schema = schemas[op];
+  if (schema === undefined) {
+    return [
+      {
+        code: "unknown-op",
+        severity: "error",
+        message: t.unknownCommand(op),
+        pointer,
+        op,
+      },
+    ];
+  }
+  const payload: Record<string, unknown> = {
+    ...(cmd as Record<string, unknown>),
+  };
+  delete payload.op;
+  const result = schema.safeParse(payload);
+  if (result.success) return [];
+  return result.error.issues.map((issue) =>
+    issueToDiagnostic(issue, pointer, op, t),
+  );
+}