@pixi-ui-editor/schema 0.13.0 → 0.15.0

package/dist/index.js

@@ -6,7 +6,8 @@ import { collectBindingKeys, collectBindingKeyScopes } from "./bindingKeys.js";
 import { collectLocalizationIssues, createDefaultLocalization, LocalizationSchema } from "./localization.js";
 export { collectBindingKeys, collectBindingKeyScopes, OWNER_BINDING_KEY_SCOPE } from "./bindingKeys.js";
 export { rewriteNodeReferences, rewritePrefabInstanceReferencePatches } from "./nodeReferences.js";
-export const CURRENT_SCHEMA_VERSION = 39;
+export { clearNodeAssetReferences } from "./assetReferences.js";
+export const CURRENT_SCHEMA_VERSION = 40;
 const Id = Type.String({ format: "uuid" });
 const Name = Type.String({ minLength: 1 });
 /**
@@ -109,18 +110,25 @@ const BitmapTextAlign = Type.Union([Type.Literal("left"), Type.Literal("center")
 // A bitmap font's glyphs come pre-rendered from its texture, so unlike `Text` there is no system
 // fallback: `assetId` is required (like Spine's), and the "Bitmap Text" add-node entry stays disabled
 // until at least one `bitmapFont` asset exists — a bitmap-text node with no asset has nothing to draw.
+const BitmapTextStyle = Type.Object({
+    assetId: Id,
+    // The authored/preferred size. With `autoSize` on, this doubles as the upper bound the runtime
+    // shrinks down from — never grows past it — the same "Best Fit" contract Unity's legacy Text uses.
+    fontSize: Type.Number({ exclusiveMinimum: 0 }),
+    fill: Type.String({ pattern: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" }),
+    align: BitmapTextAlign,
+    verticalAlign: Type.Union([Type.Literal("top"), Type.Literal("middle"), Type.Literal("bottom")]),
+    letterSpacing: Type.Number(),
+    wordWrap: Type.Boolean(),
+});
+const BitmapTextOverrides = Type.Partial(Type.Object({ desktop: Type.Partial(BitmapTextStyle), mobile: Type.Partial(BitmapTextStyle) }));
 const BitmapText = Type.Composite([NodeBase, Type.Object({
         type: Type.Literal("bitmap-text"),
+        // Content and runtime fit are shared. The visual font presentation follows the same base/mobile
+        // override convention as `Text.style`; text remains one localization/game-data value.
         text: Type.String(),
-        assetId: Id,
-        // The authored/preferred size. With `autoSize` on, this doubles as the upper bound the runtime
-        // shrinks down from — never grows past it — the same "Best Fit" contract Unity's legacy Text uses.
-        fontSize: Type.Number({ exclusiveMinimum: 0 }),
-        fill: Type.String({ pattern: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$" }),
-        align: BitmapTextAlign,
-        verticalAlign: Type.Union([Type.Literal("top"), Type.Literal("middle"), Type.Literal("bottom")]),
-        letterSpacing: Type.Number(),
-        wordWrap: Type.Boolean(),
+        ...BitmapTextStyle.properties,
+        bitmapTextOverrides: Type.Optional(BitmapTextOverrides),
         // Omitted/false keeps the historical behavior: fixed `fontSize`, overflow simply clips/overruns.
         autoSize: Type.Optional(Type.Boolean()),
         // The floor `autoSize` won't shrink past; omitted defaults to 1 at the runtime/view layer, not here,
@@ -422,6 +430,12 @@ const structural = documentAjv.compile(ProjectDocumentSchema);
 const structuralNode = createAjv().compile(UINodeSchema);
 export function createStableId() { return crypto.randomUUID(); }
 const add = (issues, code, path, message) => issues.push({ code, path, message, severity: "error" });
+// A missing asset reference is downgraded to a warning: deleting an asset must always be possible
+// (see AssetPanel's delete action), and after deletion any node still pointing at it necessarily
+// dangles. Blocking the whole document as invalid would make asset deletion silently no-op instead —
+// exactly the confusing "it won't delete" experience this severity exists to avoid. A type mismatch
+// (`INCOMPATIBLE_ASSET_REFERENCE`) stays an error: that is real corruption, not a dangling reference.
+const addWarning = (issues, code, path, message) => issues.push({ code, path, message, severity: "warning" });
 /** Общая проверка владельца: одинаковые issue получают и сцена, и определение пресета. */
 function checkBindingKeys(document, owner, path, issues) {
     const graph = resolveOwnerNodeGraph(document, owner);
@@ -571,14 +585,14 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
         if ((node.type === "image" || node.type === "spine") && node.assetId !== undefined) {
             const asset = assets.get(node.assetId);
             if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/assetId`, `Asset '${node.assetId}' does not exist.`);
+                addWarning(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/assetId`, `Asset '${node.assetId}' does not exist.`);
             else if (asset.type !== node.type)
                 add(issues, "INCOMPATIBLE_ASSET_REFERENCE", `${nodePath}/assetId`, `A ${node.type} node requires a ${node.type} asset.`);
         }
         if (isLayoutGroup(node) && node.backgroundAssetId !== undefined) {
             const asset = assets.get(node.backgroundAssetId);
             if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/backgroundAssetId`, `Background asset '${node.backgroundAssetId}' does not exist.`);
+                addWarning(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/backgroundAssetId`, `Background asset '${node.backgroundAssetId}' does not exist.`);
             else if (asset.type !== "image")
                 add(issues, "INCOMPATIBLE_ASSET_REFERENCE", `${nodePath}/backgroundAssetId`, "A layout group background requires an image asset.");
         }
@@ -586,7 +600,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
         if (node.type === "button")
             BUTTON_STATE_KEYS.forEach((state) => { const field = `${state}AssetId`; const assetId = node.states[field]; if (assetId === undefined)
                 return; const asset = assets.get(assetId), path = `${nodePath}/states/${field}`; if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", path, `Asset '${assetId}' does not exist.`);
+                addWarning(issues, "MISSING_ASSET_REFERENCE", path, `Asset '${assetId}' does not exist.`);
             else if (asset.type !== "image")
                 add(issues, "INCOMPATIBLE_ASSET_REFERENCE", path, `A button '${state}' state requires an image asset.`); });
         if (node.type === "button")
@@ -596,7 +610,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     continue;
                 const asset = assets.get(assetId), soundPath = `${nodePath}/sounds/${field}`;
                 if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", soundPath, `Asset '${assetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", soundPath, `Asset '${assetId}' does not exist.`);
                 else if (asset.type !== "sound")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", soundPath, `A button ${field} requires a sound asset.`);
             }
@@ -608,7 +622,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                 stageIds.add(stage.id);
                 BUTTON_STATE_KEYS.forEach((state) => { const field = `${state}AssetId`; const assetId = stage.states[field]; if (assetId === undefined)
                     return; const asset = assets.get(assetId), statePath = `${nodePath}/stages/${stageIndex}/states/${field}`; if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", statePath, `Asset '${assetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", statePath, `Asset '${assetId}' does not exist.`);
                 else if (asset.type !== "image")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", statePath, `A staged button stage '${state}' state requires an image asset.`); });
             });
@@ -620,7 +634,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     continue;
                 const asset = assets.get(assetId), soundPath = `${nodePath}/sounds/${field}`;
                 if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", soundPath, `Asset '${assetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", soundPath, `Asset '${assetId}' does not exist.`);
                 else if (asset.type !== "sound")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", soundPath, `A staged button ${field} requires a sound asset.`);
             }
@@ -628,7 +642,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
         if (node.type === "checkbox")
             CHECKBOX_STATE_KEYS.forEach((state) => { const field = `${state}AssetId`; const assetId = node.states[field]; if (assetId === undefined)
                 return; const asset = assets.get(assetId), path = `${nodePath}/states/${field}`; if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", path, `Asset '${assetId}' does not exist.`);
+                addWarning(issues, "MISSING_ASSET_REFERENCE", path, `Asset '${assetId}' does not exist.`);
             else if (asset.type !== "image")
                 add(issues, "INCOMPATIBLE_ASSET_REFERENCE", path, `A checkbox '${state}' state requires an image asset.`); });
         if (node.type === "checkbox")
@@ -638,16 +652,25 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     continue;
                 const asset = assets.get(assetId), soundPath = `${nodePath}/sounds/${field}`;
                 if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", soundPath, `Asset '${assetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", soundPath, `Asset '${assetId}' does not exist.`);
                 else if (asset.type !== "sound")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", soundPath, `A checkbox ${field} requires a sound asset.`);
             }
         if (node.type === "bitmap-text") {
-            const asset = assets.get(node.assetId);
-            if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/assetId`, `Asset '${node.assetId}' does not exist.`);
-            else if (asset.type !== "bitmapFont")
-                add(issues, "INCOMPATIBLE_ASSET_REFERENCE", `${nodePath}/assetId`, "A bitmap text node requires a bitmap font asset.");
+            const fontReferences = [
+                [node.assetId, `${nodePath}/assetId`],
+                [node.bitmapTextOverrides?.desktop?.assetId, `${nodePath}/bitmapTextOverrides/desktop/assetId`],
+                [node.bitmapTextOverrides?.mobile?.assetId, `${nodePath}/bitmapTextOverrides/mobile/assetId`],
+            ];
+            for (const [assetId, assetPath] of fontReferences) {
+                if (assetId === undefined)
+                    continue;
+                const asset = assets.get(assetId);
+                if (!asset)
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", assetPath, `Asset '${assetId}' does not exist.`);
+                else if (asset.type !== "bitmapFont")
+                    add(issues, "INCOMPATIBLE_ASSET_REFERENCE", assetPath, "A bitmap text node requires a bitmap font asset.");
+            }
         }
         if (node.type === "text") {
             const fontReferences = [
@@ -660,7 +683,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     continue;
                 const asset = assets.get(fontAssetId);
                 if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", fontPath, `Asset '${fontAssetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", fontPath, `Asset '${fontAssetId}' does not exist.`);
                 else if (asset.type !== "font")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", fontPath, "A text node fontAssetId requires a font asset.");
             }
@@ -668,14 +691,14 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
         if (node.type === "input" && node.backgroundAssetId !== undefined) {
             const asset = assets.get(node.backgroundAssetId);
             if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/backgroundAssetId`, `Background asset '${node.backgroundAssetId}' does not exist.`);
+                addWarning(issues, "MISSING_ASSET_REFERENCE", `${nodePath}/backgroundAssetId`, `Background asset '${node.backgroundAssetId}' does not exist.`);
             else if (asset.type !== "image")
                 add(issues, "INCOMPATIBLE_ASSET_REFERENCE", `${nodePath}/backgroundAssetId`, "An input background requires an image asset.");
         }
         if (node.type === "input" && node.textStyle.fontAssetId !== undefined) {
             const asset = assets.get(node.textStyle.fontAssetId), path = `${nodePath}/textStyle/fontAssetId`;
             if (!asset)
-                add(issues, "MISSING_ASSET_REFERENCE", path, `Asset '${node.textStyle.fontAssetId}' does not exist.`);
+                addWarning(issues, "MISSING_ASSET_REFERENCE", path, `Asset '${node.textStyle.fontAssetId}' does not exist.`);
             else if (asset.type !== "font")
                 add(issues, "INCOMPATIBLE_ASSET_REFERENCE", path, "An input node textStyle fontAssetId requires a font asset.");
         }
@@ -687,7 +710,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                 const asset = assets.get(assetId);
                 const assetPath = `${nodePath}/${field}`;
                 if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", assetPath, `Asset '${assetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", assetPath, `Asset '${assetId}' does not exist.`);
                 else if (asset.type !== "image")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", assetPath, `A ${node.type} ${field} requires an image asset.`);
             }
@@ -700,7 +723,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
             if (node.valueTextStyle?.fontAssetId !== undefined) {
                 const asset = assets.get(node.valueTextStyle.fontAssetId), fontPath = `${nodePath}/valueTextStyle/fontAssetId`;
                 if (!asset)
-                    add(issues, "MISSING_ASSET_REFERENCE", fontPath, `Asset '${node.valueTextStyle.fontAssetId}' does not exist.`);
+                    addWarning(issues, "MISSING_ASSET_REFERENCE", fontPath, `Asset '${node.valueTextStyle.fontAssetId}' does not exist.`);
                 else if (asset.type !== "font")
                     add(issues, "INCOMPATIBLE_ASSET_REFERENCE", fontPath, "A slider valueTextStyle fontAssetId requires a font asset.");
             }
@@ -718,7 +741,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     }
                     const asset = assets.get(assetId);
                     if (!asset)
-                        add(issues, "MISSING_ASSET_REFERENCE", assetPath, `Asset '${assetId}' does not exist.`);
+                        addWarning(issues, "MISSING_ASSET_REFERENCE", assetPath, `Asset '${assetId}' does not exist.`);
                     else if (asset.type !== "image")
                         add(issues, "INCOMPATIBLE_ASSET_REFERENCE", assetPath, `A pagination ${field} requires an image asset.`);
                 }
@@ -728,7 +751,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     const asset = assets.get(node.numberStyle.fontAssetId);
                     const fontPath = `${nodePath}/numberStyle/fontAssetId`;
                     if (!asset)
-                        add(issues, "MISSING_ASSET_REFERENCE", fontPath, `Asset '${node.numberStyle.fontAssetId}' does not exist.`);
+                        addWarning(issues, "MISSING_ASSET_REFERENCE", fontPath, `Asset '${node.numberStyle.fontAssetId}' does not exist.`);
                     else if (asset.type !== "font")
                         add(issues, "INCOMPATIBLE_ASSET_REFERENCE", fontPath, "A pagination numberStyle fontAssetId requires a font asset.");
                 }
@@ -736,7 +759,7 @@ function hierarchy(owner, path, assets, prefabs, effects, issues) {
                     const asset = assets.get(node.numberActiveBackgroundAssetId);
                     const bgPath = `${nodePath}/numberActiveBackgroundAssetId`;
                     if (!asset)
-                        add(issues, "MISSING_ASSET_REFERENCE", bgPath, `Asset '${node.numberActiveBackgroundAssetId}' does not exist.`);
+                        addWarning(issues, "MISSING_ASSET_REFERENCE", bgPath, `Asset '${node.numberActiveBackgroundAssetId}' does not exist.`);
                     else if (asset.type !== "image")
                         add(issues, "INCOMPATIBLE_ASSET_REFERENCE", bgPath, "A pagination numberActiveBackgroundAssetId requires an image asset.");
                 }
@@ -801,7 +824,7 @@ function semantic(document) {
         add(issues, "INVALID_PARTICLE_RANGE", `${p}/${field}`, "Particle range min must not exceed max."); }); if (e.rate === 0 && e.bursts.length === 0)
         add(issues, "EMPTY_PARTICLE_EMISSION", `${p}/emission`, "Particle emission needs a rate or a burst."); e.bursts.forEach((burst, j) => { if (burst.time > e.duration)
         add(issues, "PARTICLE_BURST_OUTSIDE_DURATION", `${p}/emission/bursts/${j}/time`, "Particle burst time must be inside emission duration."); }); const source = v.source; particleAssetIds(effect).forEach((id, j) => { const asset = assets.get(id), sourcePath = source.type === "single" ? `${p}/particle/visual/source/assetId` : `${p}/particle/visual/source/assetIds/${j}`; if (!asset)
-        add(issues, "MISSING_ASSET_REFERENCE", sourcePath, `Asset '${id}' does not exist.`);
+        addWarning(issues, "MISSING_ASSET_REFERENCE", sourcePath, `Asset '${id}' does not exist.`);
     else if (asset.type !== "image")
         add(issues, "INCOMPATIBLE_ASSET_REFERENCE", sourcePath, "Particle visual source requires an image asset or atlas frame."); }); });
     document.prefabs.forEach((prefab, i) => { register(prefab.id, `/prefabs/${i}/id`); prefabs.add(prefab.id); });
@@ -856,7 +879,7 @@ function semantic(document) {
         validateInstance(node, `/scenes/${i}/nodes/${j}`); }); const musicAssetId = scene.audio?.backgroundMusicAssetId; if (musicAssetId !== undefined) {
         const asset = assets.get(musicAssetId), musicPath = `/scenes/${i}/audio/backgroundMusicAssetId`;
         if (!asset)
-            add(issues, "MISSING_ASSET_REFERENCE", musicPath, `Asset '${musicAssetId}' does not exist.`);
+            addWarning(issues, "MISSING_ASSET_REFERENCE", musicPath, `Asset '${musicAssetId}' does not exist.`);
         else if (asset.type !== "sound")
             add(issues, "INCOMPATIBLE_ASSET_REFERENCE", musicPath, "Background music requires a sound asset.");
     } checkBindingKeys(document, scene, `/scenes/${i}`, issues); checkNodeReferences(document, scene, `/scenes/${i}`, issues); });
@@ -1271,11 +1294,15 @@ function migrateV32ToV33(document) {
     normalizeLegacySpineConnectors(document);
     normalizeLegacyPagination(document);
 }
+/** v40 adds sparse bitmap-text presentation overrides; existing values remain the shared base. */
+function migrateV39ToV40(_document) { }
 export function migrateProjectDocument(input) {
     if (typeof input !== "object" || input === null || !Object.hasOwn(input, "schemaVersion"))
         throw new ProjectDocumentMigrationError("A schemaVersion is required for migration.");
     const version = input.schemaVersion;
-    if (typeof version !== "number" || !Number.isInteger(version) || version < 1 || version > CURRENT_SCHEMA_VERSION)
+    if (typeof version === "number" && Number.isInteger(version) && version > CURRENT_SCHEMA_VERSION)
+        throw new ProjectDocumentMigrationError(`This project was saved with schema version ${version}, which is newer than schema version ${CURRENT_SCHEMA_VERSION} supported by this editor. Update the editor to open it.`);
+    if (typeof version !== "number" || !Number.isInteger(version) || version < 1)
         throw new ProjectDocumentMigrationError(`Unsupported schemaVersion '${String(version)}'.`);
     const migrated = structuredClone(input);
     if (version <= 1)
@@ -1324,6 +1351,8 @@ export function migrateProjectDocument(input) {
         migrateV31ToV32(migrated);
     if (version <= 32)
         migrateV32ToV33(migrated);
+    if (version <= 39)
+        migrateV39ToV40(migrated);
     // v36 → v37 (position multiplier у spine-коннекторов) не требует переписывания данных:
     // добавлены только опциональные поля коннектора, и любой документ v36 уже валиден как v37.
     // v34 → v35 (`states.normalAssetId` стал опциональным у button/staged-button) не требует
@@ -1338,6 +1367,7 @@ export function migrateProjectDocument(input) {
     // v15 хранить не мог, поэтому запрещённых значений в старых документах не бывает.
     // v38 → v39 (per-state button tint/opacity) не требует переписывания данных: новые appearance
     // fields optional and therefore resolve to white / 1 for every existing button.
+    // v39 → v40 (bitmap-text presentation overrides) likewise adds only optional sparse fields.
     // v37 → v38 (page-group carousel arrows) не требует переписывания данных: добавлены только
     // опциональные поля `pageUpButtonNodeId`/`pageDownButtonNodeId`, любой документ v37 уже валиден как v38.
     migrated.schemaVersion = CURRENT_SCHEMA_VERSION;