@openfairygui/cli 0.2.0-alpha.0 → 0.2.0-alpha.2

package/dist/cli.mjs

@@ -1,4 +1,5 @@
-import { BackendRuntime } from "@openfairygui/backend";
+import { createRequire } from "node:module";
+import { createNodeBackendRuntime } from "@openfairygui/backend/node";
 import * as fs$1 from "node:fs/promises";
 import fs from "node:fs/promises";
 import * as path$1 from "node:path";
@@ -10142,6 +10143,10 @@ function parseComboBoxItemXmlNode(item) {
 		icon: readXmlAttr(item, specs.icon) ?? null
 	};
 }
+function getProjectBasePath(fs, projectPath) {
+	const basePath = fs.dirname(projectPath);
+	return basePath === "." ? "" : basePath;
+}
 var ProjectReader = class {
 	_fs;
 	constructor(fs) {
@@ -10150,7 +10155,7 @@ var ProjectReader = class {
 	async read(projectPath) {
 		const fs = this._fs;
 		const doc = new Document();
-		const basePath = projectPath.replace(/[/\\][^/\\]*\.fairy$/i, "");
+		const basePath = getProjectBasePath(fs, projectPath);
 		const ctx = new ReaderContext(doc, basePath);
 		const projDesc = getXmlNode(parseXML(await fs.readFile(projectPath)).projectDescription);
 		if (projDesc) {
@@ -20721,8 +20726,8 @@ function getPixelHitTestEntry(resource) {
 /**
 * Abstract I/O base class for reading and writing FairyGUI projects.
 *
-* Platform-specific subclasses (NodeIO, WebIO) implement the file system
-* abstraction required by the reader/writer.
+* Platform-specific adapters provide the file system abstraction required by
+* the reader/writer.
 *
 * @category I/O
 */
@@ -20748,7 +20753,7 @@ var PlatformIO = class {
 * Usage:
 *
 * ```ts
-* import { NodeIO } from '@openfairygui/core';
+* import { NodeIO } from '@openfairygui/core/node';
 *
 * const io = new NodeIO();
 * const doc = await io.readProject('./path/to/project.fairy');
@@ -24525,6 +24530,15 @@ Options:
 Input can be a .fairy file or a project root directory (auto-discovers .fairy file).
 File extension and binary format are read from project settings.
 `;
+const require = createRequire(import.meta.url);
+function readPackageVersion() {
+	try {
+		const pkg = require("../package.json");
+		if (typeof pkg.version === "string" && pkg.version.length > 0) return pkg.version;
+	} catch {}
+	return "0.2.0-alpha.2";
+}
+const PACKAGE_VERSION = readPackageVersion();
 /** Resolve input to a .fairy file path. Accepts a directory or a .fairy file. */
 async function resolveFairyPath(input) {
 	const resolved = path.resolve(input);
@@ -24545,7 +24559,7 @@ async function main() {
 		return;
 	}
 	if (args.includes("--version") || args.includes("-v")) {
-		console.log("0.1.0");
+		console.log(PACKAGE_VERSION);
 		return;
 	}
 	const command = args[0];
@@ -24859,7 +24873,7 @@ async function cmdBackendCapabilities(args) {
 		console.error("Usage: ofgui backend-capabilities <project-dir>");
 		process.exit(1);
 	}
-	const runtime = new BackendRuntime();
+	const runtime = createNodeBackendRuntime();
 	const opened = await runtime.openSession({ projectPath: path.resolve(args[0]) });
 	if (!opened.ok) {
 		console.error(`backend-capabilities: ${opened.error.message}`);

package/package.json

@@ -1,48 +1,48 @@
 {
-	"name": "@openfairygui/cli",
-	"version": "0.2.0-alpha.0",
-	"description": "FairyGUI Headless Authoring SDK — command-line interface.",
-	"author": "OpenFairyGUI Contributors",
-	"license": "MIT",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/OpenFairyGUI/OpenFairyGUI.git",
-		"directory": "packages/cli"
-	},
-	"homepage": "https://github.com/OpenFairyGUI/OpenFairyGUI#readme",
-	"bugs": {
-		"url": "https://github.com/OpenFairyGUI/OpenFairyGUI/issues"
-	},
-	"type": "module",
-	"bin": {
-		"ofgui": "bin/cli.cjs",
-		"openfairygui": "bin/cli.cjs"
-	},
-	"scripts": {
-		"build": "tsdown src/cli.ts --format esm --platform node --no-dts --external sharp"
-	},
-	"files": [
-		"dist/",
-		"bin/",
-		"src/"
-	],
-	"keywords": [
-		"fairygui",
-		"cli",
-		"ui",
-		"headless",
-		"authoring",
-		"publish",
-		"restore"
-	],
-	"devDependencies": {
-		"@openfairygui/core": "workspace:*",
-		"@openfairygui/functions": "workspace:*"
-	},
-	"dependencies": {
-		"@openfairygui/backend": "workspace:*"
-	},
-	"optionalDependencies": {
-		"sharp": ">=0.33.0"
-	}
-}
+  "name": "@openfairygui/cli",
+  "version": "0.2.0-alpha.2",
+  "description": "FairyGUI Headless Authoring SDK — command-line interface.",
+  "author": "OpenFairyGUI Contributors",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenFairyGUI/OpenFairyGUI.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://github.com/OpenFairyGUI/OpenFairyGUI#readme",
+  "bugs": {
+    "url": "https://github.com/OpenFairyGUI/OpenFairyGUI/issues"
+  },
+  "type": "module",
+  "bin": {
+    "ofgui": "bin/cli.cjs",
+    "openfairygui": "bin/cli.cjs"
+  },
+  "files": [
+    "dist/",
+    "bin/",
+    "src/"
+  ],
+  "keywords": [
+    "fairygui",
+    "cli",
+    "ui",
+    "headless",
+    "authoring",
+    "publish",
+    "restore"
+  ],
+  "devDependencies": {
+    "@openfairygui/core": "0.2.0-alpha.2",
+    "@openfairygui/functions": "0.2.0-alpha.2"
+  },
+  "dependencies": {
+    "@openfairygui/backend": "0.2.0-alpha.2"
+  },
+  "optionalDependencies": {
+    "sharp": ">=0.33.0"
+  },
+  "scripts": {
+    "build": "tsdown src/cli.ts --format esm --platform node --no-dts --external sharp --env.PACKAGE_VERSION=$npm_package_version"
+  }
+}

package/src/cli.ts

@@ -1,8 +1,6 @@
-import { BackendRuntime } from '@openfairygui/backend';
-import {
-	NodeIO,
-	ProjectType,
-} from '@openfairygui/core';
+import { createNodeBackendRuntime } from '@openfairygui/backend/node';
+import { ProjectType } from '@openfairygui/core';
+import { NodeIO } from '@openfairygui/core/node';
 import {
 	inspect,
 	publish,
@@ -17,6 +15,7 @@ import {
 	type RestoreImageExtractor,
 } from '@openfairygui/functions';
 import fs from 'node:fs/promises';
+import { createRequire } from 'node:module';
 import path from 'node:path';
 import { parseArgs } from 'node:util';
 
@@ -53,6 +52,22 @@ Input can be a .fairy file or a project root directory (auto-discovers .fairy fi
 File extension and binary format are read from project settings.
 `;
 
+const require = createRequire(import.meta.url);
+
+function readPackageVersion(): string {
+	try {
+		const pkg = require('../package.json') as { version?: unknown };
+		if (typeof pkg.version === 'string' && pkg.version.length > 0) {
+			return pkg.version;
+		}
+	} catch {
+		// Keep the CLI usable when executed from a bundled artifact missing package.json.
+	}
+	return '0.2.0-alpha.2';
+}
+
+const PACKAGE_VERSION = readPackageVersion();
+
 /** Resolve input to a .fairy file path. Accepts a directory or a .fairy file. */
 async function resolveFairyPath(input: string): Promise<string> {
 	const resolved = path.resolve(input);
@@ -70,7 +85,9 @@ async function resolveFairyPath(input: string): Promise<string> {
 			return path.join(resolved, fairyFiles[0]);
 		}
 		if (fairyFiles.length > 1) {
-			throw new Error(`Multiple .fairy files found in ${resolved}: ${fairyFiles.join(', ')}. Please specify one.`);
+			throw new Error(
+				`Multiple .fairy files found in ${resolved}: ${fairyFiles.join(', ')}. Please specify one.`,
+			);
 		}
 		throw new Error(`No .fairy file found in ${resolved}`);
 	}
@@ -87,7 +104,7 @@ async function main(): Promise<void> {
 	}
 
 	if (args.includes('--version') || args.includes('-v')) {
-		console.log('0.1.0');
+		console.log(PACKAGE_VERSION);
 		return;
 	}
 
@@ -195,24 +212,25 @@ async function createRestoreImageProcessors(): Promise<RestoreImageProcessors> {
 		});
 		if (input.rotated) image = image.rotate(90);
 		const { data, info } = await image.png().toBuffer({ resolveWithObject: true });
-		const needsOriginalCanvas = input.expectedWidth > 0 && input.expectedHeight > 0 && (
-			input.offsetX !== 0
-			|| input.offsetY !== 0
-			|| info.width !== input.expectedWidth
-			|| info.height !== input.expectedHeight
-		);
+		const needsOriginalCanvas =
+			input.expectedWidth > 0 &&
+			input.expectedHeight > 0 &&
+			(input.offsetX !== 0 ||
+				input.offsetY !== 0 ||
+				info.width !== input.expectedWidth ||
+				info.height !== input.expectedHeight);
 
 		if (needsOriginalCanvas) {
 			if (
-				input.offsetX < 0
-				|| input.offsetY < 0
-				|| input.offsetX + info.width > input.expectedWidth
-				|| input.offsetY + info.height > input.expectedHeight
+				input.offsetX < 0 ||
+				input.offsetY < 0 ||
+				input.offsetX + info.width > input.expectedWidth ||
+				input.offsetY + info.height > input.expectedHeight
 			) {
 				throw new Error(
-					`restore: Cropped image does not fit original canvas for ${targetPath}: `
-					+ `crop ${info.width}x${info.height} at ${input.offsetX},${input.offsetY}, `
-					+ `canvas ${input.expectedWidth}x${input.expectedHeight}`,
+					`restore: Cropped image does not fit original canvas for ${targetPath}: ` +
+						`crop ${info.width}x${info.height} at ${input.offsetX},${input.offsetY}, ` +
+						`canvas ${input.expectedWidth}x${input.expectedHeight}`,
 				);
 			}
 			const composed = await sharp({
@@ -227,26 +245,26 @@ async function createRestoreImageProcessors(): Promise<RestoreImageProcessors> {
 				.png()
 				.toBuffer({ resolveWithObject: true });
 			if (
-				input.expectedWidth > 0
-				&& input.expectedHeight > 0
-				&& (composed.info.width !== input.expectedWidth || composed.info.height !== input.expectedHeight)
+				input.expectedWidth > 0 &&
+				input.expectedHeight > 0 &&
+				(composed.info.width !== input.expectedWidth || composed.info.height !== input.expectedHeight)
 			) {
 				throw new Error(
-					`restore: Cropped image size mismatch for ${targetPath}: `
-					+ `expected ${input.expectedWidth}x${input.expectedHeight}, got ${composed.info.width}x${composed.info.height}`,
+					`restore: Cropped image size mismatch for ${targetPath}: ` +
+						`expected ${input.expectedWidth}x${input.expectedHeight}, got ${composed.info.width}x${composed.info.height}`,
 				);
 			}
 			return composed.data;
 		}
 
 		if (
-			input.expectedWidth > 0
-			&& input.expectedHeight > 0
-			&& (info.width !== input.expectedWidth || info.height !== input.expectedHeight)
+			input.expectedWidth > 0 &&
+			input.expectedHeight > 0 &&
+			(info.width !== input.expectedWidth || info.height !== input.expectedHeight)
 		) {
 			throw new Error(
-				`restore: Cropped image size mismatch for ${targetPath}: `
-				+ `expected ${input.expectedWidth}x${input.expectedHeight}, got ${info.width}x${info.height}`,
+				`restore: Cropped image size mismatch for ${targetPath}: ` +
+					`expected ${input.expectedWidth}x${input.expectedHeight}, got ${info.width}x${info.height}`,
 			);
 		}
 		return data;
@@ -294,7 +312,9 @@ function printReport(report: InspectReport): void {
 	console.log('\nPackage details:');
 	for (const pkg of report.packages) {
 		const res = pkg.resources;
-		console.log(`  ${pkg.name} (${pkg.id}): ${res.images.count} img, ${res.sounds.count} snd, ${res.fonts.count} font, ${res.components.count} comp`);
+		console.log(
+			`  ${pkg.name} (${pkg.id}): ${res.images.count} img, ${res.sounds.count} snd, ${res.fonts.count} font, ${res.components.count} comp`,
+		);
 	}
 }
 
@@ -347,7 +367,12 @@ async function cmdRestore(args: string[]): Promise<void> {
 
 	const releaseDir = path.resolve(positionals[0]);
 	const outputDir = path.resolve(values.output);
-	const pkgFilter = values.packages ? values.packages.split(',').map((s) => s.trim()).filter(Boolean) : undefined;
+	const pkgFilter = values.packages
+		? values.packages
+				.split(',')
+				.map((s) => s.trim())
+				.filter(Boolean)
+		: undefined;
 	const projectType = parseProjectType(values['project-type']);
 	const { cropImage, extractImage } = await createRestoreImageProcessors();
 
@@ -385,7 +410,9 @@ async function cmdPublish(args: string[]): Promise<void> {
 	});
 
 	if (positionals.length === 0 || !values.output) {
-		console.error('Usage: ofgui publish <project-dir> --output <dir> [--compressed] [--packages a,b,c] [--branch name]');
+		console.error(
+			'Usage: ofgui publish <project-dir> --output <dir> [--compressed] [--packages a,b,c] [--branch name]',
+		);
 		process.exit(1);
 	}
 
@@ -454,17 +481,19 @@ async function cmdPublish(args: string[]): Promise<void> {
 		},
 	};
 
-	await doc.transform(publish({
-		output: outputDir,
-		compressed: resolved.compressed,
-		fileExtension: resolved.fileExtension,
-		packages: resolved.packages,
-		fs: publishFs,
-		encoder,
-		basePath: path.join(projectDir, 'assets'),
-		atlas: atlasConfig,
-		branch: values.branch,
-	}));
+	await doc.transform(
+		publish({
+			output: outputDir,
+			compressed: resolved.compressed,
+			fileExtension: resolved.fileExtension,
+			packages: resolved.packages,
+			fs: publishFs,
+			encoder,
+			basePath: path.join(projectDir, 'assets'),
+			atlas: atlasConfig,
+			branch: values.branch,
+		}),
+	);
 
 	console.log(`\nDone! Output: ${outputDir}`);
 }
@@ -475,7 +504,7 @@ async function cmdBackendCapabilities(args: string[]): Promise<void> {
 		process.exit(1);
 	}
 
-	const runtime = new BackendRuntime();
+	const runtime = createNodeBackendRuntime();
 	const opened = await runtime.openSession({ projectPath: path.resolve(args[0]) });
 	if (!opened.ok) {
 		const failure = opened as Extract<typeof opened, { ok: false }>;