@pixi-ui-editor/schema 0.1.0

package/dist/assetPaths.d.ts

@@ -0,0 +1,31 @@
+import type { Asset } from "./index.js";
+export declare function sanitizeName(name: string): string;
+/** Image/font/sound assets have no uploaded file name, so the file name is the asset name plus a mediaType extension. */
+export declare function imageFileName(asset: {
+    name: string;
+    source: {
+        mediaType: string;
+    };
+}): string;
+export declare function fontFileName(asset: {
+    name: string;
+    source: {
+        mediaType: string;
+    };
+}): string;
+export declare function soundFileName(asset: {
+    name: string;
+    source: {
+        mediaType: string;
+    };
+}): string;
+/** Package-relative path for one asset file, per the fixed folder layout (`assets/<assetId>/<fileName>`). */
+export declare function assetFilePath(assetId: string, fileName: string): string;
+export type AssetFileEntry = {
+    path: string;
+    fileName: string;
+    mediaType: string;
+};
+/** Every relative-path file entry an asset owns: multi-file assets (atlas/Spine) keep their original uploaded file names. */
+export declare function collectAssetFileEntries(asset: Asset): AssetFileEntry[];
+//# sourceMappingURL=assetPaths.d.ts.map

package/dist/assetPaths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetPaths.d.ts","sourceRoot":"","sources":["../src/assetPaths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAyBxC,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGjD;AAED,yHAAyH;AACzH,wBAAgB,aAAa,CAAC,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAAG,MAAM,CAG5F;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAAG,MAAM,CAG3F;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAAG,MAAM,CAG5F;AAED,6GAA6G;AAC7G,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEvE;AAED,MAAM,MAAM,cAAc,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnF,6HAA6H;AAC7H,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,EAAE,CAetE"}

package/dist/assetPaths.js

@@ -0,0 +1,68 @@
+/**
+ * Single source of truth for `Asset -> project folder relative path` naming, shared by the exported ZIP
+ * package (`apps/editor-web/src/shared/exportPackage.ts`) and the IndexedDB working copy (`projectStore`):
+ * both must resolve the same asset to the same `assets/<assetId>/<fileName>` path.
+ */
+const IMAGE_EXTENSIONS = {
+    "image/png": ".png",
+    "image/jpeg": ".jpg",
+    "image/webp": ".webp",
+    "image/gif": ".gif",
+    "image/svg+xml": ".svg",
+    "image/avif": ".avif",
+};
+const SOUND_EXTENSIONS = {
+    "audio/wav": ".wav",
+    "audio/mpeg": ".mp3",
+    "audio/ogg": ".ogg",
+    "audio/aac": ".aac",
+    "audio/mp4": ".m4a",
+};
+export function sanitizeName(name) {
+    const safe = name.replace(/[^\p{L}\p{N}._-]+/gu, "-").replace(/^-+|-+$/g, "");
+    return safe === "" ? "file" : safe;
+}
+/** Image/font/sound assets have no uploaded file name, so the file name is the asset name plus a mediaType extension. */
+export function imageFileName(asset) {
+    const extension = IMAGE_EXTENSIONS[asset.source.mediaType] ?? `.${sanitizeName(asset.source.mediaType.split("/")[1] ?? "bin")}`;
+    return `${sanitizeName(asset.name)}${extension}`;
+}
+export function fontFileName(asset) {
+    const extension = asset.source.mediaType.split("/")[1] ?? "font";
+    return `${sanitizeName(asset.name)}.${sanitizeName(extension)}`;
+}
+export function soundFileName(asset) {
+    const extension = SOUND_EXTENSIONS[asset.source.mediaType] ?? `.${sanitizeName(asset.source.mediaType.split("/")[1] ?? "bin")}`;
+    return `${sanitizeName(asset.name)}${extension}`;
+}
+/** Package-relative path for one asset file, per the fixed folder layout (`assets/<assetId>/<fileName>`). */
+export function assetFilePath(assetId, fileName) {
+    return `assets/${assetId}/${fileName}`;
+}
+/** Every relative-path file entry an asset owns: multi-file assets (atlas/Spine) keep their original uploaded file names. */
+export function collectAssetFileEntries(asset) {
+    if (asset.type === "image") {
+        const fileName = imageFileName(asset);
+        return [{ path: assetFilePath(asset.id, fileName), fileName, mediaType: asset.source.mediaType }];
+    }
+    if (asset.type === "font") {
+        const fileName = fontFileName(asset);
+        return [{ path: assetFilePath(asset.id, fileName), fileName, mediaType: asset.source.mediaType }];
+    }
+    if (asset.type === "sound") {
+        const fileName = soundFileName(asset);
+        return [{ path: assetFilePath(asset.id, fileName), fileName, mediaType: asset.source.mediaType }];
+    }
+    if (asset.type === "atlas") {
+        return [
+            { path: assetFilePath(asset.id, asset.files.json.name), fileName: asset.files.json.name, mediaType: asset.files.json.mediaType },
+            { path: assetFilePath(asset.id, asset.files.texture.name), fileName: asset.files.texture.name, mediaType: asset.files.texture.mediaType },
+        ];
+    }
+    return [
+        { path: assetFilePath(asset.id, asset.files.skeleton.name), fileName: asset.files.skeleton.name, mediaType: asset.files.skeleton.mediaType },
+        { path: assetFilePath(asset.id, asset.files.atlas.name), fileName: asset.files.atlas.name, mediaType: asset.files.atlas.mediaType },
+        ...asset.files.textures.map((texture) => ({ path: assetFilePath(asset.id, texture.name), fileName: texture.name, mediaType: texture.mediaType })),
+    ];
+}
+//# sourceMappingURL=assetPaths.js.map

package/dist/assetPaths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetPaths.js","sourceRoot":"","sources":["../src/assetPaths.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,MAAM,gBAAgB,GAA2B;IAC/C,WAAW,EAAE,MAAM;IACnB,YAAY,EAAE,MAAM;IACpB,YAAY,EAAE,OAAO;IACrB,WAAW,EAAE,MAAM;IACnB,eAAe,EAAE,MAAM;IACvB,YAAY,EAAE,OAAO;CACtB,CAAC;AAEF,MAAM,gBAAgB,GAA2B;IAC/C,WAAW,EAAE,MAAM;IACnB,YAAY,EAAE,MAAM;IACpB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;CACpB,CAAC;AAEF,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC9E,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACrC,CAAC;AAED,yHAAyH;AACzH,MAAM,UAAU,aAAa,CAAC,KAAsD;IAClF,MAAM,SAAS,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;IAChI,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAsD;IACjF,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;IACjE,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAsD;IAClF,MAAM,SAAS,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;IAChI,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC;AACnD,CAAC;AAED,6GAA6G;AAC7G,MAAM,UAAU,aAAa,CAAC,OAAe,EAAE,QAAgB;IAC7D,OAAO,UAAU,OAAO,IAAI,QAAQ,EAAE,CAAC;AACzC,CAAC;AAID,6HAA6H;AAC7H,MAAM,UAAU,uBAAuB,CAAC,KAAY;IAClD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAAC,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAAC,CAAC;IACzK,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAAC,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAAC,CAAC;IACvK,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAAC,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAAC,CAAC;IACzK,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO;YACL,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE;YAChI,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE;SAC1I,CAAC;IACJ,CAAC;IACD,OAAO;QACL,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE;QAC5I,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;QACnI,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;KAClJ,CAAC;AACJ,CAAC"}

package/dist/assetPaths.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=assetPaths.test.d.ts.map

package/dist/assetPaths.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetPaths.test.d.ts","sourceRoot":"","sources":["../src/assetPaths.test.ts"],"names":[],"mappings":""}

package/dist/assetPaths.test.js

@@ -0,0 +1,26 @@
+import { describe, expect, it } from "vitest";
+import { assetFilePath, collectAssetFileEntries, imageFileName } from "./assetPaths.js";
+const assetId = "30000000-0000-4000-8000-000000000001";
+describe("asset file naming", () => {
+    it("derives an image file name from the sanitized asset name and its mediaType extension", () => {
+        expect(imageFileName({ name: "Hero Icon", source: { mediaType: "image/jpeg" } })).toBe("Hero-Icon.jpg");
+        expect(assetFilePath(assetId, imageFileName({ name: "Hero Icon", source: { mediaType: "image/jpeg" } }))).toBe(`assets/${assetId}/Hero-Icon.jpg`);
+    });
+    it("keeps atlas/Spine file names as uploaded when composing their relative path, matching export output", () => {
+        const atlas = {
+            id: assetId,
+            name: "Sparkle Sheet",
+            type: "atlas",
+            files: {
+                json: { name: "sparkles.json", uri: "assets/sparkles.json", mediaType: "application/json" },
+                texture: { name: "sparkles.png", uri: "assets/sparkles.png", mediaType: "image/png" },
+            },
+            frames: {},
+        };
+        expect(collectAssetFileEntries(atlas)).toEqual([
+            { path: `assets/${assetId}/sparkles.json`, fileName: "sparkles.json", mediaType: "application/json" },
+            { path: `assets/${assetId}/sparkles.png`, fileName: "sparkles.png", mediaType: "image/png" },
+        ]);
+    });
+});
+//# sourceMappingURL=assetPaths.test.js.map

package/dist/assetPaths.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetPaths.test.js","sourceRoot":"","sources":["../src/assetPaths.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGxF,MAAM,OAAO,GAAG,sCAAsC,CAAC;AAEvD,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;QAC9F,MAAM,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACxG,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,OAAO,gBAAgB,CAAC,CAAC;IACpJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qGAAqG,EAAE,GAAG,EAAE;QAC7G,MAAM,KAAK,GAAU;YACnB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,sBAAsB,EAAE,SAAS,EAAE,kBAAkB,EAAE;gBAC3F,OAAO,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,qBAAqB,EAAE,SAAS,EAAE,WAAW,EAAE;aACtF;YACD,MAAM,EAAE,EAAE;SACX,CAAC;QACF,MAAM,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;YAC7C,EAAE,IAAI,EAAE,UAAU,OAAO,gBAAgB,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,kBAAkB,EAAE;YACrG,EAAE,IAAI,EAAE,UAAU,OAAO,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,WAAW,EAAE;SAC7F,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}