@lingfan-engine/core 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2026 MoFeng-02
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@lingfan-engine/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "type": "module",
+  "description": "灵泛叙事引擎核心：框架无关的叙事语义（格式/执行/回溯/作用域/存档编排）",
+  "license": "Apache-2.0",
+  "exports": {
+    ".": "./src/index.ts",
+    "./contracts": "./src/contracts/index.ts"
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.ts"
+  ],
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MoFeng-02/LingFan.Engine.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/MoFeng-02/LingFan.Engine#readme",
+  "bugs": {
+    "url": "https://github.com/MoFeng-02/LingFan.Engine/issues"
+  },
+  "keywords": [
+    "narrative",
+    "visual-novel",
+    "game-engine",
+    "story",
+    "typescript",
+    "framework-agnostic"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/contracts/element.ts

@@ -0,0 +1,327 @@
+/**
+ * 元素系统契约（元素声明 / 舞台层叠）。
+ *
+ * 类型与属性全集：
+ * - 36 类型全集（文本 / 交互 / 图像 / 容器 / 滚动 / 进度 / 间隔七组）
+ * - 属性全集 = 通用属性表与元素特定属性的合并
+ *
+ * 未知类型 / 未知属性一律 fail-closed——「写了也不渲染」的静默容忍是缺陷，不是特性。
+ *
+ * 元素寻址显式化为契约字段：`id`（唯一，精确寻址）与 `name`（可重复，批量寻址），
+ * 不使用隐式魔法键。
+ */
+
+/**
+ * 元素动作序列（`ops`）中**不可用**的 op：等待类、位置类、存档类。
+ *
+ * 理由：`ops` 是「点击时按序执行一串 op」，跑在**当前叙事流的等待画面上**——
+ * 这些 op 会打断或替换该流程（进入新等待 / 换列 / 改动存档坐标），与「点一下做点事、
+ * 然后继续」的语义冲突。执行期整次拒绝（`element-ops-blocked-op`，状态原样）。
+ *
+ * 跳列请用元素的 `nav` 属性（那条路走核心 `navigate`，语义明确）。
+ * 单一事实源：引擎执行期与编辑器编辑期诊断共用本清单。
+ */
+export const ELEMENT_OPS_BLOCKED: ReadonlySet<string> = new Set([
+  // 等待类（进入新等待，替换当前流程）
+  "say",
+  "menu",
+  "input",
+  "wait",
+  "pause",
+  "nvl",
+  "cutscene",
+  "minigame",
+  // 位置类（替换命令流 / 改变叙事坐标）
+  "jump",
+  "navigate",
+  "call",
+  "return",
+  // 存档类（存档坐标必须是玩家所见的等待点，点击不是）
+  "save",
+  "load",
+  "auto_save",
+  "save_delete",
+]);
+
+/**
+ * 舞台元素类型全集（36）。
+ * 分组：文本 / 交互 / 图像 / 容器 / 滚动 / 进度 / 间隔七组。
+ */
+export const ELEMENT_TYPES = [
+  // 文本
+  "text",
+  "dialog",
+  "narrator",
+  "speaker",
+  // 交互
+  "button",
+  "choice",
+  "imagebutton",
+  // 图像
+  "image",
+  "background",
+  "portrait",
+  "video",
+  // 容器
+  "panel",
+  "frame",
+  "window",
+  "dialogbox",
+  "choicebox",
+  "infobox",
+  "overlay",
+  "popup",
+  "vbox",
+  "hbox",
+  "grid",
+  "stack",
+  "stackpanel",
+  "canvas",
+  "border",
+  // 滚动
+  "scroll",
+  "scrollviewer",
+  "viewport",
+  // 进度 / 滑块 / 选择
+  "bar",
+  "vbar",
+  "progressbar",
+  "slider",
+  "checkbox",
+  // 间隔
+  "separator",
+  "spacer",
+] as const;
+
+/** 元素类型名（从 `ELEMENT_TYPES` 派生，是元素表与校验白名单的共同键） */
+export type ElementType = (typeof ELEMENT_TYPES)[number];
+
+/** 结构字段（非属性）：type 必填，id/name 为寻址标识，children 为容器嵌套 */
+export const ELEMENT_STRUCTURAL_FIELDS: ReadonlySet<string> = new Set([
+  "type",
+  "id",
+  "name",
+  "children",
+]);
+
+/**
+ * 属性全集 = 通用属性表与元素特定属性的合并（合并结果即校验白名单）。
+ * 分组注释保留来源信息（编辑器表单按 `ELEMENT_SPECIFIC_ATTRS` 分类型提示）。
+ */
+export const ELEMENT_ATTRIBUTES: ReadonlySet<string> = new Set([
+  // 内容 / 样式
+  "class",
+  "style",
+  "source",
+  "src",
+  "path",
+  "text",
+  // 对齐
+  "align",
+  "halign",
+  "valign",
+  "xalign",
+  "yalign",
+  // 尺寸 / 位置
+  "width",
+  "height",
+  "fontSize",
+  "font",
+  "order",
+  "size",
+  "x",
+  "y",
+  "xoffset",
+  "yoffset",
+  "xanchor",
+  "yanchor",
+  "margin",
+  "padding",
+  "right",
+  "bottom",
+  "minWidth",
+  "minHeight",
+  "maxWidth",
+  "maxHeight",
+  "min",
+  "max",
+  "orientation",
+  "checked",
+  // 颜色 / 字体
+  "color",
+  "fontColor",
+  "textColor",
+  // 交互（点击优先级：disabled > nav > ops > cmd；视觉态 hover_* / selected_* / disabled_* 与点击正交）
+  "disabled",
+  "nav",
+  "ops",
+  "cmd",
+  "value",
+  "hover_source",
+  "hover_color",
+  "hover_opacity",
+  "selected_source",
+  "selected_color",
+  "disabled_source",
+  "disabled_color",
+  "disabled_opacity",
+  // Grid 附着
+  "col",
+  "row",
+  "colspan",
+  "rowspan",
+  // 外观
+  "opacity",
+  "visible",
+  "enabled",
+  "zindex",
+  "clipToBounds",
+  "cursor",
+  // 变换
+  "rotation",
+  "scale",
+  "scaleX",
+  "scaleY",
+  // 边框
+  "cornerRadius",
+  "borderBrush",
+  "borderColor",
+  "borderThickness",
+  // 容器
+  "spacing",
+  "direction",
+  "columns",
+  "rows",
+  // 文本
+  "textAlign",
+  // 图片
+  "stretch",
+  // 滚动
+  "scroll_h",
+  "scroll_v",
+]);
+
+/**
+ * 分类型属性：供编辑器表单按类型提示，
+ * 校验仍走 `ELEMENT_ATTRIBUTES` 并集（宽松归属判定）。
+ */
+export const ELEMENT_SPECIFIC_ATTRS: Readonly<
+  Record<string, readonly string[]>
+> = {
+  text: ["size"],
+  dialog: ["size"],
+  narrator: ["size"],
+  speaker: ["size"],
+  grid: ["columns", "rows"],
+  panel: ["direction", "spacing"],
+  vbox: ["direction", "spacing"],
+  hbox: ["direction", "spacing"],
+  frame: ["direction", "spacing"],
+  window: ["direction", "spacing"],
+  dialogbox: ["direction", "spacing"],
+  choicebox: ["direction", "spacing"],
+  infobox: ["direction", "spacing"],
+  overlay: ["direction", "spacing"],
+  popup: ["direction", "spacing"],
+  stack: ["direction", "spacing"],
+  stackpanel: ["direction", "spacing"],
+  image: ["stretch"],
+  imagebutton: [
+    "stretch",
+    "hover_source",
+    "selected_source",
+    "disabled_source",
+  ],
+  portrait: ["stretch"],
+  slider: ["min", "max", "orientation"],
+  progressbar: ["min", "max"],
+  bar: ["min", "max"],
+  vbar: ["min", "max"],
+  checkbox: ["checked"],
+  scroll: ["scroll_h", "scroll_v"],
+  scrollviewer: ["scroll_h", "scroll_v"],
+  viewport: ["scroll_h", "scroll_v"],
+};
+
+/**
+ * 舞台元素声明节点（scene 列 `elements[]` 的元素）。
+ * JSON 形态为平铺（
+ * `{ "type": "image", "source": "Images/bg.png", "x": "0" }`），属性与 type 同级。
+ */
+export interface ElementNode {
+  type: string;
+  /** 唯一标识（同列内重复 = fail-closed）；show/hide/animate 的首选目标 */
+  id?: string;
+  /** 可重复的分组标识（批量寻址：一次操作一组元素） */
+  name?: string;
+  /** 容器专有：子元素（投影为缩进子元素行） */
+  children?: ElementNode[];
+  /** 其余键 = 属性全集（校验白名单） */
+  [attr: string]: unknown;
+}
+
+/**
+ * 运行期元素实例：装载进 `SYS.elements`，随快照 / 存档 / 回溯自动随行
+ * （整体 state Map 快照，无需重放重建）。
+ */
+export interface ElementInstance {
+  /** 稳定标识：显式 id > 派生 `{列id}#{序号}`（派生值仅供内部兜底，不作为稳定契约） */
+  id: string;
+  type: string;
+  /** 分组标识（可重复；未声明则不出现） */
+  name?: string;
+  /** ELEMENT_ATTRIBUTES 内的属性副本（不含 type/id/name/children） */
+  props: Record<string, unknown>;
+  /** 舞台内叠放序：显式 `zindex` > 到达序（声明顺序 + 动态追加序） */
+  z: number;
+  children: ElementInstance[];
+}
+
+/**
+ * 容器类型：支持 `children` 嵌套。
+ * 统一口径为「容器 = 支持 children」，取 vbox/hbox 等可嵌套类型的并集。
+ */
+export const ELEMENT_CONTAINER_TYPES: ReadonlySet<string> = new Set([
+  "panel",
+  "frame",
+  "window",
+  "dialogbox",
+  "choicebox",
+  "infobox",
+  "overlay",
+  "popup",
+  "vbox",
+  "hbox",
+  "grid",
+  "stack",
+  "stackpanel",
+  "canvas",
+  "border",
+  "scroll",
+  "scrollviewer",
+  "viewport",
+]);
+
+/**
+ * 元素动画描述（`animate` / `animate_block` 写入 `SYS.animations`）。
+ *
+ * 分工：核心层只写「动画描述」（离散、进快照），**UI 每帧插值**应用到 DOM
+ * （帧驱动；高频帧级值不进 SSOT/事件流），播毕调 `animationFinished(seq)`
+ * 由核心把终值写回元素 `props`——保证快照/存档/回溯都是**终态**语义。
+ *
+ * 用**队列 + 完成回调**表达动画，避免为每个动画属性铺一串状态键。
+ */
+export interface AnimationSpec {
+  /** 动画归属元素 id（写入时由 `target` 寻址解析并**固化**，避免回溯后寻址漂移） */
+  target: string;
+  /** 动效属性名（元素属性全集内的数值属性） */
+  property: string;
+  from: number;
+  to: number;
+  /** 时长（秒） */
+  duration: number;
+  /** 缓动名（默认 `EaseOutQuad`；UI 侧映射到实际缓动函数） */
+  easing: string;
+  /** 单调序号：同一目标的连续动画、重放后的同命令可分辨（参考 `__video` 的 seq 去重语义） */
+  seq: number;
+}