@openfairygui/cli 0.2.0-alpha.13 → 0.2.0-alpha.14

package/dist/cli.mjs

@@ -1549,6 +1549,13 @@ var ImageResource = class extends ExtensibleProperty {
 	setImageData(buffer) {
 		return this.setRef("imageData", buffer);
 	}
+	/** Primary source-file bytes for this image resource. */
+	getSourceData() {
+		return this.getImageData();
+	}
+	setSourceData(buffer) {
+		return this.setImageData(buffer);
+	}
 	getPixelHitTestData() {
 		const pixelWidth = this.get("pixelHitTestPixelWidth");
 		const scaleDenominator = this.get("pixelHitTestScaleDenominator");
@@ -1634,6 +1641,13 @@ var MiscResource = class extends ExtensibleProperty {
 	setResourceData(buffer) {
 		return this.setRef("resourceData", buffer);
 	}
+	/** Primary source-file bytes for this miscellaneous resource. */
+	getSourceData() {
+		return this.getResourceData();
+	}
+	setSourceData(buffer) {
+		return this.setResourceData(buffer);
+	}
 };
 //#endregion
 //#region ../core/src/properties/sound-resource.ts
@@ -1698,6 +1712,13 @@ var SoundResource = class extends ExtensibleProperty {
 	setSoundData(buffer) {
 		return this.setRef("soundData", buffer);
 	}
+	/** Primary source-file bytes for this sound resource. */
+	getSourceData() {
+		return this.getSoundData();
+	}
+	setSourceData(buffer) {
+		return this.setSoundData(buffer);
+	}
 };
 //#endregion
 //#region ../core/src/properties/font-resource.ts
@@ -1727,7 +1748,8 @@ var FontResource = class extends ExtensibleProperty {
 			fontSize: 0,
 			xAdvance: 0,
 			lineHeight: 0,
-			glyphs: new RefList()
+			glyphs: new RefList(),
+			sourceData: null
 		});
 	}
 	getId() {
@@ -1835,6 +1857,13 @@ var FontResource = class extends ExtensibleProperty {
 	listGlyphs() {
 		return this.listRefs("glyphs");
 	}
+	/** Primary source-file bytes for this font resource. */
+	getSourceData() {
+		return this.getRef("sourceData");
+	}
+	setSourceData(buffer) {
+		return this.setRef("sourceData", buffer);
+	}
 };
 //#endregion
 //#region ../core/src/properties/movie-clip-resource.ts
@@ -1862,7 +1891,8 @@ var MovieClipResource = class extends ExtensibleProperty {
 			swing: false,
 			repeatDelay: 0,
 			smoothing: true,
-			frames: new RefList()
+			frames: new RefList(),
+			sourceData: null
 		});
 	}
 	getId() {
@@ -1958,6 +1988,13 @@ var MovieClipResource = class extends ExtensibleProperty {
 	listFrames() {
 		return this.listRefs("frames");
 	}
+	/** Primary source-file bytes for this movie-clip resource. */
+	getSourceData() {
+		return this.getRef("sourceData");
+	}
+	setSourceData(buffer) {
+		return this.setRef("sourceData", buffer);
+	}
 };
 //#endregion
 //#region ../core/src/properties/skeleton-resource-base.ts
@@ -1979,7 +2016,8 @@ var SkeletonResourceBase = class extends ExtensibleProperty {
 			requireIds: [],
 			atlasNames: [],
 			anchorX: 0,
-			anchorY: 0
+			anchorY: 0,
+			sourceData: null
 		});
 	}
 	getId() {
@@ -2058,6 +2096,13 @@ var SkeletonResourceBase = class extends ExtensibleProperty {
 		this.setAnchorX(x);
 		return this.setAnchorY(y);
 	}
+	/** Primary source-file bytes for this skeleton resource. */
+	getSourceData() {
+		return this.getRef("sourceData");
+	}
+	setSourceData(buffer) {
+		return this.setRef("sourceData", buffer);
+	}
 };
 //#endregion
 //#region ../core/src/properties/spine-resource.ts
@@ -10375,7 +10420,7 @@ var ProjectReader = class {
 	constructor(fs) {
 		this._fs = fs;
 	}
-	async read(projectPath) {
+	async read(projectPath, options = {}) {
 		const fs = this._fs;
 		const doc = new Document();
 		const basePath = getProjectBasePath(fs, projectPath);
@@ -10399,9 +10444,9 @@ var ProjectReader = class {
 		for (const dirName of packageDirs) {
 			const pkgXmlPath = fs.join(assetsPath, dirName, "package.xml");
 			if (!await fs.exists(pkgXmlPath)) continue;
-			await this._readPackage(ctx, dirName, pkgXmlPath);
+			await this._readPackage(ctx, dirName, pkgXmlPath, "", options);
 		}
-		const branchNames = await this._readPackageBranches(ctx);
+		const branchNames = await this._readPackageBranches(ctx, options);
 		if (branchNames.length > 0) doc.getRoot().setBranches(branchNames);
 		for (const [_key, resource] of ctx.resourceMap) {
 			if (resource.propertyType !== "Component") continue;
@@ -10417,7 +10462,7 @@ var ProjectReader = class {
 		}
 		return doc;
 	}
-	async _readPackageBranches(ctx) {
+	async _readPackageBranches(ctx, options) {
 		const fs = this._fs;
 		let dirNames = [];
 		try {
@@ -10437,7 +10482,7 @@ var ProjectReader = class {
 			for (const dirName of packageDirs) {
 				const pkgXmlPath = fs.join(branchAssetsPath, dirName, "package_branch.xml");
 				if (!await fs.exists(pkgXmlPath)) continue;
-				await this._readPackage(ctx, dirName, pkgXmlPath, branchName);
+				await this._readPackage(ctx, dirName, pkgXmlPath, branchName, options);
 			}
 		}
 		return branchNames;
@@ -10475,7 +10520,7 @@ var ProjectReader = class {
 		} catch {}
 		ctx.document.getRoot().setSettings(ctx.settings);
 	}
-	async _readPackage(ctx, dirName, pkgXmlPath, branchName = "") {
+	async _readPackage(ctx, dirName, pkgXmlPath, branchName = "", options = {}) {
 		const fs = this._fs;
 		const content = await fs.readFile(pkgXmlPath);
 		const xml = parseXML(content);
@@ -10513,6 +10558,7 @@ var ProjectReader = class {
 				if (resource) createdResources.push(resource);
 			}
 			await this._hydratePackageImageSizes(createdResources, packageDir);
+			if (options.hydrateResourceBytes) await this._hydratePackageResourceBytes(ctx.document, createdResources, packageDir);
 			return;
 		}
 		for (const tagName of [
@@ -10521,6 +10567,8 @@ var ProjectReader = class {
 			"font",
 			"sound",
 			"movieclip",
+			"spine",
+			"dragonbones",
 			"swf",
 			"misc",
 			"atlas"
@@ -10534,6 +10582,7 @@ var ProjectReader = class {
 			}
 		}
 		await this._hydratePackageImageSizes(createdResources, packageDir);
+		if (options.hydrateResourceBytes) await this._hydratePackageResourceBytes(ctx.document, createdResources, packageDir);
 	}
 	async _hydratePackageImageSizes(resources, packageDir) {
 		const fs = this._fs;
@@ -10544,7 +10593,9 @@ var ProjectReader = class {
 			const fileName = image.getFileName?.() ?? "";
 			if (!fileName) continue;
 			const resourcePath = image.getPath?.() ?? "/";
-			const filePath = fs.join(packageDir, resourcePath.replace(/^\//, ""), fileName);
+			const sourcePath = this._packageRelativeSourcePath(resourcePath, fileName);
+			if (!sourcePath) continue;
+			const filePath = fs.join(packageDir, sourcePath.replace(/^\/+/, ""));
 			if (!await fs.exists(filePath)) continue;
 			try {
 				const size = readImageSize(await fs.readFileRaw(filePath));
@@ -10554,6 +10605,44 @@ var ProjectReader = class {
 			} catch {}
 		}
 	}
+	async _hydratePackageResourceBytes(doc, resources, packageDir) {
+		const fs = this._fs;
+		for (const resource of resources) {
+			const fileName = this._primaryResourceFileName(resource);
+			if (!fileName) continue;
+			const resourcePath = resource.getPath?.() ?? "/";
+			const sourcePath = this._packageRelativeSourcePath(resourcePath, fileName);
+			if (!sourcePath) continue;
+			const filePath = fs.join(packageDir, sourcePath.replace(/^\/+/, ""));
+			if (!await fs.exists(filePath)) continue;
+			try {
+				const data = new Uint8Array(await fs.readFileRaw(filePath));
+				const buffer = doc.createBuffer().setURI(sourcePath).setData(data);
+				this._asSourceDataResource(resource).setSourceData(buffer);
+			} catch {}
+		}
+	}
+	_primaryResourceFileName(resource) {
+		switch (resource.propertyType) {
+			case "ImageResource":
+			case "FontResource":
+			case "MovieClipResource": return resource.getFileName();
+			case "SoundResource":
+			case "MiscResource":
+			case "SpineResource":
+			case "DragonBonesResource": return resource.getFile();
+			default: return "";
+		}
+	}
+	_packageRelativeSourcePath(resourcePath, fileName) {
+		if (!fileName || /[\\/:]/.test(fileName) || fileName === "." || fileName === "..") return null;
+		const segments = resourcePath.replace(/\\/g, "/").split("/").filter(Boolean);
+		if (segments.some((segment) => segment === "." || segment === ".." || segment.includes(":"))) return null;
+		return `/${[...segments, fileName].join("/")}`;
+	}
+	_asSourceDataResource(resource) {
+		return resource;
+	}
 	_createResourceFromXML(ctx, pkg, tagName, attrs, packageDir, branchName = "") {
 		const doc = ctx.document;
 		const fs = this._fs;
@@ -12425,21 +12514,18 @@ function assertDisplayListVariantAllowed(propertyType, tagName, childName) {
 	const variantName = getDisplayListVariantName(propertyType, tagName);
 	if (!DISPLAY_LIST_ALLOWED_VARIANTS.has(variantName)) throw new Error(`displayList variant "${variantName}" derived from propertyType "${propertyType}" is not declared in protocol for child "${childName}"`);
 }
-/**
-* Writes a {@link Document} to disk as a FairyGUI project
-* (.fairy file + settings JSON + assets directory with package.xml and component XML files).
-*
-* @category I/O
-*/
 var ProjectWriter = class {
 	_fs;
 	constructor(fs) {
 		this._fs = fs;
 	}
-	async write(doc, projectPath) {
+	async write(doc, projectPath, options = {}) {
 		const fs = this._fs;
 		const root = doc.getRoot();
 		const basePath = fs.dirname(projectPath);
+		const currentSourceFilePaths = /* @__PURE__ */ new Set();
+		const staleSourceFilePaths = new Set((options.staleSourceFiles ?? []).map((source) => this._projectSourceFilePath(basePath, source)));
+		for (const pkg of root.listPackages()) this._assertPackageOutputTargets(pkg);
 		const fairyXml = `<?xml version="1.0" encoding="utf-8"?>\n<projectDescription id="${root.getProjectId()}" type="${this._projectTypeName(root.getProjectType())}" version="${root.getVersion() || "3.0"}"/>\n`;
 		await fs.writeFile(projectPath, fairyXml);
 		const settings = root.getSettings?.() ?? {};
@@ -12452,10 +12538,12 @@ var ProjectWriter = class {
 		})) if (settings[key]) await fs.writeFile(fs.join(settingsPath, fileName), JSON.stringify(settings[key], null, "	"));
 		const assetsPath = fs.join(basePath, "assets");
 		await fs.mkdir(assetsPath);
-		for (const pkg of root.listPackages()) await this._writePackage(doc, pkg, assetsPath);
+		for (const pkg of root.listPackages()) await this._writePackage(doc, pkg, assetsPath, currentSourceFilePaths);
+		await this._removeStaleSourceFiles(currentSourceFilePaths, staleSourceFilePaths);
 	}
-	async _writePackage(_doc, pkg, assetsPath) {
+	async _writePackage(_doc, pkg, assetsPath, currentSourceFilePaths) {
 		const fs = this._fs;
+		this._assertSafePathSegment(pkg.getName(), "package name");
 		const pkgDir = fs.join(assetsPath, pkg.getName());
 		await fs.mkdir(pkgDir);
 		const basePath = fs.dirname(assetsPath);
@@ -12496,14 +12584,94 @@ var ProjectWriter = class {
 		if (publishAtlases.length > 0) publishAttrs.atlas = publishAtlases;
 		await fs.writeFile(fs.join(pkgDir, "package.xml"), this._renderPackageDescriptionXml(packageDescriptionAttrs, mainResources, publishAttrs));
 		for (const comp of mainResources.filter((resource) => resource.propertyType === "Component")) await this._writeComponent(comp, pkgDir);
+		await this._writeResourceSourceFiles(mainResources, pkgDir, currentSourceFilePaths);
 		for (const [branchName, branchResources] of resourcesByBranch) {
 			if (!branchName) continue;
+			this._assertSafePathSegment(branchName, "branch name");
 			const branchPkgDir = fs.join(basePath, `assets_${branchName}`, pkg.getName());
 			await fs.mkdir(branchPkgDir);
 			await fs.writeFile(fs.join(branchPkgDir, "package_branch.xml"), this._renderBranchDescriptionXml(branchResources));
 			for (const comp of branchResources.filter((resource) => resource.propertyType === "Component")) await this._writeComponent(comp, branchPkgDir);
+			await this._writeResourceSourceFiles(branchResources, branchPkgDir, currentSourceFilePaths);
+		}
+	}
+	async _writeResourceSourceFiles(resources, packageDir, currentSourceFilePaths) {
+		const fs = this._fs;
+		for (const resource of resources) {
+			if (resource.propertyType === "Component") continue;
+			const fileName = this._resourceFileName(resource);
+			if (!fileName) continue;
+			const relativePath = this._resourceSourceRelativePath(resource, fileName);
+			const targetPath = fs.join(packageDir, relativePath);
+			currentSourceFilePaths.add(targetPath);
+			const sourceData = resource.getSourceData?.();
+			if (!sourceData) continue;
+			const data = sourceData.getData();
+			if (!data) continue;
+			await fs.mkdir(fs.dirname(targetPath));
+			await fs.writeFileRaw(targetPath, new Uint8Array(data));
+		}
+	}
+	async _removeStaleSourceFiles(currentSourceFilePaths, staleSourceFilePaths) {
+		const fs = this._fs;
+		const candidates = [...staleSourceFilePaths].filter((filePath) => !currentSourceFilePaths.has(filePath));
+		if (candidates.length === 0) return;
+		if (!fs.unlink) throw new Error("Project source cleanup requires a FileSystem.unlink() implementation.");
+		for (const filePath of candidates) {
+			if (!await fs.exists(filePath)) continue;
+			await fs.unlink(filePath);
 		}
 	}
+	_assertPackageOutputTargets(pkg) {
+		this._assertSafePathSegment(pkg.getName(), "package name");
+		const resourcesByBranch = /* @__PURE__ */ new Map();
+		for (const resource of pkg.listResources()) {
+			const branchName = resource.getBranch?.() ?? "";
+			const bucket = resourcesByBranch.get(branchName) ?? [];
+			bucket.push(resource);
+			resourcesByBranch.set(branchName, bucket);
+		}
+		for (const [branchName, resources] of resourcesByBranch) {
+			if (branchName) this._assertSafePathSegment(branchName, "branch name");
+			const targets = new Map([[branchName ? "package_branch.xml" : "package.xml", "package descriptor"]]);
+			for (const resource of resources) {
+				const target = resource.propertyType === "Component" ? this._componentSourceRelativePath(resource) : this._resourceSourceRelativePath(resource, this._resourceFileName(resource));
+				if (!target) continue;
+				const previous = targets.get(target);
+				if (previous) throw new Error(`Package "${pkg.getName()}" output "${target}" conflicts with ${previous}.`);
+				targets.set(target, `resource "${resource.getId?.() ?? resource.getName()}"`);
+			}
+		}
+	}
+	_projectSourceFilePath(basePath, source) {
+		this._assertSafePathSegment(source.packageName, "stale source package name");
+		if (source.branch) this._assertSafePathSegment(source.branch, "stale source branch name");
+		this._assertSafePathSegment(source.fileName, "stale source file name");
+		const relativePath = this._normalizeSourceRelativePath([source.path, source.fileName].filter(Boolean).join("/"));
+		const assetRoot = source.branch ? `assets_${source.branch}` : "assets";
+		return this._fs.join(basePath, assetRoot, source.packageName, relativePath);
+	}
+	_resourceSourceRelativePath(resource, fileName) {
+		if (!fileName) return "";
+		this._assertSafePathSegment(fileName, "resource file name");
+		const normalizedPath = (resource.getPath?.() ?? "/").replace(/\\/g, "/").replace(/^\/+|\/+$/g, "");
+		return this._normalizeSourceRelativePath([normalizedPath, fileName].filter(Boolean).join("/"));
+	}
+	_componentSourceRelativePath(component) {
+		const typedComponent = component;
+		const name = component.getName();
+		this._assertSafePathSegment(name, "component name");
+		const componentPath = typedComponent.getPath?.() ?? "/";
+		return this._normalizeSourceRelativePath([componentPath, `${name}.xml`].filter(Boolean).join("/"));
+	}
+	_assertSafePathSegment(value, label) {
+		if (!value || value === "." || value === ".." || /[\\/:]/.test(value)) throw new Error(`Invalid ${label} "${value}".`);
+	}
+	_normalizeSourceRelativePath(value) {
+		const segments = value.replace(/\\/g, "/").split("/").filter(Boolean);
+		if (segments.some((segment) => segment === "." || segment === ".." || segment.includes(":"))) throw new Error(`Invalid project source path "${value}".`);
+		return segments.join("/");
+	}
 	_renderPackageDescriptionXml(packageDescriptionAttrs, resources, publishAttrs) {
 		const publishNodeAttrs = Object.fromEntries(Object.entries(publishAttrs).filter(([key]) => key !== "atlas"));
 		const lines = [
@@ -12647,11 +12815,8 @@ var ProjectWriter = class {
 	async _writeComponent(comp, pkgDir) {
 		const fs = this._fs;
 		const typedComp = comp;
-		const path = typedComp.getPath?.() ?? "/";
-		const name = comp.getName() + ".xml";
-		const subDir = path.replace(/^\//, "").replace(/\/$/, "");
-		const fileDir = subDir ? fs.join(pkgDir, subDir) : pkgDir;
-		if (subDir) await fs.mkdir(fileDir);
+		const targetPath = fs.join(pkgDir, this._componentSourceRelativePath(comp));
+		await fs.mkdir(fs.dirname(targetPath));
 		const compAttrs = {};
 		const [w, h] = [typedComp.getWidth?.() ?? 0, typedComp.getHeight?.() ?? 0];
 		if (w || h) writeXmlAttr(compAttrs, PROJECT_XML_PROTOCOL.componentRoot.attrs.size, `${w},${h}`);
@@ -12793,7 +12958,7 @@ var ProjectWriter = class {
 			},
 			component: compNode
 		};
-		await fs.writeFile(fs.join(fileDir, name), builder.build(xmlObj));
+		await fs.writeFile(targetPath, builder.build(xmlObj));
 	}
 	_serializeController(ctrl) {
 		const pagesStr = ctrl.listPages().map((p) => `${p.getId()},${p.getName()}`).join(",");
@@ -21033,11 +21198,11 @@ function getPixelHitTestEntry(resource) {
 * @category I/O
 */
 var PlatformIO = class {
-	async readProject(projectPath) {
-		return new ProjectReader(this.createFileSystem()).read(projectPath);
+	async readProject(projectPath, options) {
+		return new ProjectReader(this.createFileSystem()).read(projectPath, options);
 	}
-	async writeProject(doc, projectPath) {
-		return new ProjectWriter(this.createFileSystem()).write(doc, projectPath);
+	async writeProject(doc, projectPath, options) {
+		return new ProjectWriter(this.createFileSystem()).write(doc, projectPath, options);
 	}
 	async readBinary(filePath) {
 		return new BinaryReader(this.createFileSystem()).read(filePath);
@@ -25216,6 +25381,9 @@ var NodeIO = class extends PlatformIO {
 					return false;
 				}
 			},
+			async unlink(filePath) {
+				await fs$1.unlink(filePath);
+			},
 			join(...paths) {
 				return path$1.join(...paths);
 			},
@@ -25358,8 +25526,8 @@ async function resolveNodeAssetsPath(document, assetsPath) {
 }
 async function loadSharpBackend() {
 	try {
-		const sharp = await importNative("sharp");
-		return sharp.default ?? sharp;
+		const loaded = await importNative("sharp");
+		return loaded.default ?? loaded;
 	} catch {
 		return;
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfairygui/cli",
-  "version": "0.2.0-alpha.13",
+  "version": "0.2.0-alpha.14",
   "description": "FairyGUI Headless Authoring SDK — command-line interface.",
   "author": "OpenFairyGUI Contributors",
   "license": "MIT",
@@ -33,13 +33,13 @@
     "restore"
   ],
   "devDependencies": {
-    "@openfairygui/core": "0.2.0-alpha.13",
-    "@openfairygui/functions": "0.2.0-alpha.13"
+    "@openfairygui/functions": "0.2.0-alpha.14",
+    "@openfairygui/core": "0.2.0-alpha.14"
   },
   "dependencies": {
     "commander": "^14.0.2",
     "jiti": "^2.7.0",
-    "@openfairygui/backend": "0.2.0-alpha.13"
+    "@openfairygui/backend": "0.2.0-alpha.14"
   },
   "optionalDependencies": {
     "sharp": ">=0.33.0"