@pixi-ui-editor/schema 0.11.0 → 0.13.0

package/dist/index.js

@@ -5,7 +5,8 @@ import { applyPrefabNodePatch, materializePrefabInstance, PREFAB_NODE_PATH_SEPAR
 import { collectBindingKeys, collectBindingKeyScopes } from "./bindingKeys.js";
 import { collectLocalizationIssues, createDefaultLocalization, LocalizationSchema } from "./localization.js";
 export { collectBindingKeys, collectBindingKeyScopes, OWNER_BINDING_KEY_SCOPE } from "./bindingKeys.js";
-export const CURRENT_SCHEMA_VERSION = 37;
+export { rewriteNodeReferences, rewritePrefabInstanceReferencePatches } from "./nodeReferences.js";
+export const CURRENT_SCHEMA_VERSION = 39;
 const Id = Type.String({ format: "uuid" });
 const Name = Type.String({ minLength: 1 });
 /**
@@ -69,7 +70,12 @@ const TextStyleOverrides = Type.Partial(Type.Object({ desktop: Type.Partial(Text
 // 1) to keep the rendered text inside the resolved rectangle. Both live on the node itself, not inside
 // `style`/`textStyleOverrides`: shrinking is a runtime fit computed from the resolved box at render
 // time, not an authored per-orientation style choice, the same reasoning bitmap text's fields follow.
-const Text = Type.Composite([NodeBase, Type.Object({ type: Type.Literal("text"), text: Type.String(), textKey: Type.Optional(Type.String()), style: Type.Optional(TextStyleDefinitionSchema), textStyleOverrides: Type.Optional(TextStyleOverrides), autoSize: Type.Optional(Type.Boolean()), minFontSize: Type.Optional(Type.Number({ exclusiveMinimum: 0 })) })]);
+export const TextCaseSchema = Type.Union([Type.Literal("none"), Type.Literal("uppercase"), Type.Literal("lowercase")]);
+// Display-only transform applied on top of the resolved string (authored text, translation, or live
+// preview) right before it reaches the renderer/measurer — never written back into `text`/catalog
+// entries, so switching the case later, or reading the source string back out, stays lossless.
+// Omitted/`"none"` keeps historical documents byte-for-byte unchanged without a migration.
+const Text = Type.Composite([NodeBase, Type.Object({ type: Type.Literal("text"), text: Type.String(), textKey: Type.Optional(Type.String()), style: Type.Optional(TextStyleDefinitionSchema), textStyleOverrides: Type.Optional(TextStyleOverrides), autoSize: Type.Optional(Type.Boolean()), minFontSize: Type.Optional(Type.Number({ exclusiveMinimum: 0 })), textCase: Type.Optional(TextCaseSchema) })]);
 // Optional preserves existing documents; omitted animationSpeed is interpreted as 1 by every runtime.
 // `autoplay` is the serialized initial playback decision. Older documents are migrated to true,
 // preserving the runtime behavior they had before this field became explicit.
@@ -139,7 +145,16 @@ export const PrefabNodeOverrideSchema = Type.Object({
 export const BUTTON_STATE_KEYS = ["normal", "hover", "pressed", "disabled"];
 /** Discriminated transition: в v0 поддержан только `instant`, чтобы позже добавить bump/slide/fade без неявных полей. */
 const ButtonTransition = Type.Object({ kind: Type.Literal("instant") });
-const ButtonStates = Type.Object({ normalAssetId: Type.Optional(Id), hoverAssetId: Type.Optional(Id), pressedAssetId: Type.Optional(Id), disabledAssetId: Type.Optional(Id) });
+const ButtonTint = Type.String({ pattern: "^#[0-9A-Fa-f]{6}$" });
+/**
+ * Appearance is owned by each visual button state. Missing tint/opacity deliberately mean the
+ * neutral Pixi values (white and 1), so existing button artwork preserves its exact appearance.
+ */
+const ButtonStates = Type.Object({
+    normalAssetId: Type.Optional(Id), hoverAssetId: Type.Optional(Id), pressedAssetId: Type.Optional(Id), disabledAssetId: Type.Optional(Id),
+    normalTint: Type.Optional(ButtonTint), hoverTint: Type.Optional(ButtonTint), pressedTint: Type.Optional(ButtonTint), disabledTint: Type.Optional(ButtonTint),
+    normalOpacity: Type.Optional(Type.Number({ minimum: 0, maximum: 1 })), hoverOpacity: Type.Optional(Type.Number({ minimum: 0, maximum: 1 })), pressedOpacity: Type.Optional(Type.Number({ minimum: 0, maximum: 1 })), disabledOpacity: Type.Optional(Type.Number({ minimum: 0, maximum: 1 })),
+});
 const ButtonSounds = Type.Object({ pressAssetId: Type.Optional(Id), hoverAssetId: Type.Optional(Id) });
 const ButtonTransitions = Type.Partial(Type.Object({ normal: ButtonTransition, hover: ButtonTransition, pressed: ButtonTransition, disabled: ButtonTransition }));
 // `enabled` — сериализованное начальное presentation-состояние; runtime setter документ не меняет.
@@ -187,7 +202,17 @@ const ScrollView = Type.Composite([NodeBase, Type.Object({ type: Type.Literal("s
 // `defaultPage` is the authored/initial visible page; switching pages at runtime is driven one-way by
 // game code (or the standalone `pagination` widget's `onPageChange`) through `setPageGroupPage`, never
 // by the group itself — it has no built-in swipe gesture or transition.
-const PageGroup = Type.Composite([NodeBase, Type.Object({ type: Type.Literal("page-group"), defaultPage: Type.Integer({ minimum: 0 }) })]);
+// Optional carousel arrows: existing authored buttons wired the same way `pagination`'s
+// `prevButtonNodeId`/`nextButtonNodeId` are (ADR 0043) — the group renders nothing of its own, only
+// subscribes to a press. `pageUpButtonNodeId` advances (wraps past the last page to the first),
+// `pageDownButtonNodeId` goes back (wraps past the first page to the last) — unlike pagination's
+// prev/next, page-group never disables an arrow at the edge of the range, because there is no edge.
+const PageGroup = Type.Composite([NodeBase, Type.Object({
+        type: Type.Literal("page-group"),
+        defaultPage: Type.Integer({ minimum: 0 }),
+        pageUpButtonNodeId: Type.Optional(NodeAddress),
+        pageDownButtonNodeId: Type.Optional(NodeAddress),
+    })]);
 // Контейнер фиксированной вместимости: держит список дочерних узлов и показывает только первые
 // `visibleCount` из них, остальные скрыты всегда. Это не страницы (`page-group` показывает ровно
 // одного ребёнка и растягивает его на себя) и не раскладка (`isPositionManagingContainer` его не
@@ -447,6 +472,20 @@ function checkNodeReferences(document, owner, path, issues) {
             }
             continue;
         }
+        if (node.type === "page-group") {
+            for (const field of ["pageUpButtonNodeId", "pageDownButtonNodeId"]) {
+                const buttonId = node[field];
+                if (buttonId === undefined)
+                    continue;
+                const arrowPath = `${path}/pageGroupArrows/${node.id}/${field}`;
+                const target = nodes.get(buttonId);
+                if (target === undefined)
+                    add(issues, "MISSING_PAGE_GROUP_ARROW", arrowPath, `Page group arrow '${buttonId}' does not exist in this owner.`);
+                else if (target.type !== "button" && target.type !== "staged-button")
+                    add(issues, "INVALID_PAGE_GROUP_ARROW", arrowPath, "A page group arrow must reference a button or staged-button node.");
+            }
+            continue;
+        }
         if (node.type !== "spine")
             continue;
         const claimedSlots = new Set();
@@ -1297,6 +1336,10 @@ export function migrateProjectDocument(input) {
     // старого. `propertyOverrides[].nodeId` и `parentId` локального узла стали путями, а путь длиной в
     // один сегмент — это ровно прежний id узла определения; вложенных инстансов в `locallyAddedNodes`
     // v15 хранить не мог, поэтому запрещённых значений в старых документах не бывает.
+    // v38 → v39 (per-state button tint/opacity) не требует переписывания данных: новые appearance
+    // fields optional and therefore resolve to white / 1 for every existing button.
+    // v37 → v38 (page-group carousel arrows) не требует переписывания данных: добавлены только
+    // опциональные поля `pageUpButtonNodeId`/`pageDownButtonNodeId`, любой документ v37 уже валиден как v38.
     migrated.schemaVersion = CURRENT_SCHEMA_VERSION;
     assertProjectDocument(migrated);
     return migrated;