@openfairygui/functions 0.2.0-alpha.7 → 0.2.0

package/dist/web.js

@@ -0,0 +1,439 @@
+import { c as resolveCodeGenerationSettings, n as resolvePublishOptions, t as publish } from "./publish-DXoaC1Nl.js";
+import { ProjectType } from "@openfairygui/core";
+import { XMLParser, XMLValidator } from "fast-xml-parser";
+//#region src/adapters/web/raster.ts
+const MAX_SVG_SOURCE_BYTES = 8 * 1024 * 1024;
+const MAX_SVG_DIMENSION = 16384;
+const MAX_SVG_PIXELS = 64 * 1024 * 1024;
+const MAX_SVG_NODES = 5e4;
+const UNSAFE_SVG_ELEMENTS = new Set([
+	"a",
+	"animate",
+	"animatecolor",
+	"animatemotion",
+	"animatetransform",
+	"audio",
+	"canvas",
+	"discard",
+	"embed",
+	"feimage",
+	"foreignobject",
+	"iframe",
+	"image",
+	"object",
+	"script",
+	"set",
+	"style",
+	"video"
+]);
+function unsafeSvg(message) {
+	throw new Error(`publishBrowser: unsafe SVG input (${message}).`);
+}
+function svgLocalName(name) {
+	return name.split(":").at(-1).toLowerCase();
+}
+function parseSvgLength(value, name) {
+	if (value === void 0) return void 0;
+	const match = String(value).match(/^\s*(?:\d+(?:\.\d+)?|\.\d+)(?:px)?\s*$/iu);
+	if (!match) unsafeSvg(`${name} must use a finite pixel value`);
+	const parsed = Number.parseFloat(match[0]);
+	if (!Number.isFinite(parsed) || parsed <= 0 || parsed > MAX_SVG_DIMENSION) unsafeSvg(`${name} exceeds the supported dimensions`);
+	return parsed;
+}
+function validateSvgAttribute(name, value) {
+	const normalizedName = name.toLowerCase();
+	if (normalizedName === "xmlns" || normalizedName.startsWith("xmlns:")) return;
+	const localName = svgLocalName(name);
+	const text = String(value);
+	if (localName.startsWith("on")) unsafeSvg(`event attribute "${name}" is not allowed`);
+	if (localName === "style" || localName === "src") unsafeSvg(`attribute "${name}" is not allowed`);
+	if (localName === "href" && !/^#[A-Za-z_][\w:.-]*$/u.test(text)) unsafeSvg(`external reference in "${name}" is not allowed`);
+	if (/(?:^|[\s("'=])(?:https?:|file:|javascript:|data:|\/\/)/iu.test(text)) unsafeSvg(`external URL in "${name}" is not allowed`);
+	for (const match of text.matchAll(/url\s*\(([^)]*)\)/giu)) {
+		const reference = (match[1] ?? "").trim().replace(/^(['"])(.*)\1$/u, "$2");
+		if (!/^#[A-Za-z_][\w:.-]*$/u.test(reference)) unsafeSvg(`external url() in "${name}" is not allowed`);
+	}
+}
+function visitSvgEntry(entry) {
+	const pending = [entry];
+	let nodeCount = 0;
+	while (pending.length > 0) {
+		const current = pending.pop();
+		for (const [name, value] of Object.entries(current)) {
+			if (name === ":@" || name.startsWith("#") || name.startsWith("?")) continue;
+			if (++nodeCount > MAX_SVG_NODES) unsafeSvg("node count exceeds the supported limit");
+			const localName = svgLocalName(name);
+			if (UNSAFE_SVG_ELEMENTS.has(localName)) unsafeSvg(`element <${name}> is not allowed`);
+			for (const [attributeName, attributeValue] of Object.entries(current[":@"] ?? {})) validateSvgAttribute(attributeName, attributeValue);
+			if (Array.isArray(value)) {
+				for (const child of value) if (child && typeof child === "object" && !Array.isArray(child)) pending.push(child);
+			}
+		}
+	}
+}
+function validateSvg(bytes) {
+	if (bytes.byteLength === 0 || bytes.byteLength > MAX_SVG_SOURCE_BYTES) unsafeSvg("source size is unsupported");
+	let source;
+	try {
+		source = new TextDecoder("utf-8", { fatal: true }).decode(bytes);
+	} catch {
+		unsafeSvg("source is not valid UTF-8");
+	}
+	if (/<!\s*(?:doctype|entity)\b|<\?xml-stylesheet\b/iu.test(source)) unsafeSvg("DTD, entities, and stylesheets are not allowed");
+	if (XMLValidator.validate(source, { allowBooleanAttributes: false }) !== true) unsafeSvg("source is not well-formed XML");
+	const roots = new XMLParser({
+		preserveOrder: true,
+		ignoreAttributes: false,
+		attributeNamePrefix: "",
+		parseAttributeValue: false,
+		parseTagValue: false,
+		processEntities: false,
+		trimValues: false
+	}).parse(source).flatMap((entry) => Object.keys(entry).filter((name) => name !== ":@" && !name.startsWith("#") && !name.startsWith("?")).map((name) => ({
+		entry,
+		name
+	})));
+	if (roots.length !== 1 || svgLocalName(roots[0].name) !== "svg") unsafeSvg("a single <svg> root is required");
+	const root = roots[0].entry;
+	visitSvgEntry(root);
+	const attributes = root[":@"] ?? {};
+	const width = parseSvgLength(attributes.width, "width");
+	const height = parseSvgLength(attributes.height, "height");
+	let viewBoxWidth;
+	let viewBoxHeight;
+	if (attributes.viewBox !== void 0) {
+		const viewBox = String(attributes.viewBox).trim().split(/[\s,]+/u).map(Number);
+		if (viewBox.length !== 4 || viewBox.some((value) => !Number.isFinite(value)) || viewBox[2] <= 0 || viewBox[3] <= 0) unsafeSvg("viewBox must contain four finite values with positive dimensions");
+		viewBoxWidth = viewBox[2];
+		viewBoxHeight = viewBox[3];
+		if (viewBoxWidth > MAX_SVG_DIMENSION || viewBoxHeight > MAX_SVG_DIMENSION) unsafeSvg("viewBox exceeds the supported dimensions");
+	}
+	if ((width ?? viewBoxWidth ?? 300) * (height ?? viewBoxHeight ?? 150) > MAX_SVG_PIXELS) unsafeSvg("pixel count exceeds the supported limit");
+}
+function getBrowserContext(canvas) {
+	const context = canvas.getContext("2d");
+	if (!context) throw new Error("publishBrowser: a 2D canvas context is unavailable.");
+	return context;
+}
+function createBrowserCanvas(width, height) {
+	if (typeof OffscreenCanvas !== "undefined") return new OffscreenCanvas(width, height);
+	if (typeof globalThis.document === "undefined") throw new Error("publishBrowser: OffscreenCanvas or a DOM canvas is required for atlas PNG generation.");
+	const canvas = globalThis.document.createElement("canvas");
+	canvas.width = width;
+	canvas.height = height;
+	return canvas;
+}
+function assertBrowserImageSupport() {
+	if (typeof createImageBitmap !== "function") throw new Error("publishBrowser: createImageBitmap is required for atlas PNG generation.");
+	if (typeof OffscreenCanvas === "undefined" && typeof globalThis.document === "undefined") throw new Error("publishBrowser: OffscreenCanvas or a DOM canvas is required for atlas PNG generation.");
+}
+function createRaster(width, height, background) {
+	const canvas = createBrowserCanvas(width, height);
+	const context = getBrowserContext(canvas);
+	context.clearRect(0, 0, width, height);
+	if (background && background.alpha > 0) {
+		context.fillStyle = `rgba(${background.r}, ${background.g}, ${background.b}, ${background.alpha})`;
+		context.fillRect(0, 0, width, height);
+	}
+	return {
+		canvas,
+		width,
+		height
+	};
+}
+function imageMimeType(path) {
+	if (/\.svg$/iu.test(path)) return "image/svg+xml";
+	if (/\.jpe?g$/iu.test(path)) return "image/jpeg";
+	if (/\.webp$/iu.test(path)) return "image/webp";
+	if (/\.gif$/iu.test(path)) return "image/gif";
+	return "image/png";
+}
+function imageMimeTypeFromBytes(bytes) {
+	if (bytes[0] === 255 && bytes[1] === 216) return "image/jpeg";
+	if (bytes[0] === 71 && bytes[1] === 73 && bytes[2] === 70) return "image/gif";
+	if (bytes[0] === 82 && bytes[1] === 73 && bytes[2] === 70 && bytes[3] === 70) return "image/webp";
+	return "image/png";
+}
+async function canvasToPng(canvas) {
+	let blob;
+	if ("convertToBlob" in canvas && typeof canvas.convertToBlob === "function") blob = await canvas.convertToBlob({ type: "image/png" });
+	else blob = await new Promise((resolve, reject) => {
+		canvas.toBlob((value) => {
+			if (value) resolve(value);
+			else reject(/* @__PURE__ */ new Error("publishBrowser: canvas PNG encoding failed."));
+		}, "image/png");
+	});
+	return new Uint8Array(await blob.arrayBuffer());
+}
+async function decodeRaster(bytes, mimeType) {
+	if (typeof createImageBitmap !== "function") throw new Error("publishBrowser: createImageBitmap is required for atlas PNG generation.");
+	const copy = bytes.slice();
+	if (mimeType === "image/svg+xml") validateSvg(copy);
+	const blob = new Blob([copy.buffer], { type: mimeType });
+	let bitmap;
+	try {
+		bitmap = await createImageBitmap(blob);
+	} catch (error) {
+		if (mimeType !== "image/svg+xml") throw error;
+		return decodeSvgWithDom(blob);
+	}
+	try {
+		const raster = createRaster(bitmap.width, bitmap.height);
+		getBrowserContext(raster.canvas).drawImage(bitmap, 0, 0);
+		return raster;
+	} finally {
+		bitmap.close();
+	}
+}
+async function decodeSvgWithDom(blob) {
+	if (typeof globalThis.Image !== "function" || typeof globalThis.URL?.createObjectURL !== "function" || typeof globalThis.URL?.revokeObjectURL !== "function") throw new Error("publishBrowser: createImageBitmap rejected SVG and DOM image decoding is unavailable.");
+	const url = globalThis.URL.createObjectURL(blob);
+	try {
+		const image = new globalThis.Image();
+		await new Promise((resolve, reject) => {
+			image.onload = () => resolve();
+			image.onerror = () => reject(/* @__PURE__ */ new Error("publishBrowser: DOM image decoding failed for SVG."));
+			image.src = url;
+		});
+		const width = image.naturalWidth || image.width;
+		const height = image.naturalHeight || image.height;
+		if (!Number.isFinite(width) || !Number.isFinite(height) || width <= 0 || height <= 0 || width > MAX_SVG_DIMENSION || height > MAX_SVG_DIMENSION || width * height > MAX_SVG_PIXELS) unsafeSvg("decoded dimensions exceed the supported limit");
+		const raster = createRaster(width, height);
+		getBrowserContext(raster.canvas).drawImage(image, 0, 0);
+		return raster;
+	} finally {
+		globalThis.URL.revokeObjectURL(url);
+	}
+}
+var BrowserImagePipeline = class {
+	rawOutput = false;
+	constructor(raster, decode, write) {
+		this.raster = raster;
+		this.decode = decode;
+		this.write = write;
+	}
+	ensureAlpha() {
+		return this;
+	}
+	resize(options) {
+		this.raster = this.raster.then((source) => {
+			const target = createRaster(options.width, options.height);
+			getBrowserContext(target.canvas).drawImage(source.canvas, 0, 0, options.width, options.height);
+			return target;
+		});
+		return this;
+	}
+	raw() {
+		this.rawOutput = true;
+		return this;
+	}
+	extract(options) {
+		this.raster = this.raster.then((source) => {
+			const target = createRaster(options.width, options.height);
+			getBrowserContext(target.canvas).drawImage(source.canvas, options.left, options.top, options.width, options.height, 0, 0, options.width, options.height);
+			return target;
+		});
+		return this;
+	}
+	png() {
+		this.rawOutput = false;
+		return this;
+	}
+	rotate(angle) {
+		this.raster = this.raster.then((source) => {
+			if (angle % 180 === 0) return source;
+			const target = createRaster(source.height, source.width);
+			const context = getBrowserContext(target.canvas);
+			context.save();
+			if (angle === 270 || angle === -90) {
+				context.translate(0, source.width);
+				context.rotate(-Math.PI / 2);
+			} else {
+				context.translate(source.height, 0);
+				context.rotate(Math.PI / 2);
+			}
+			context.drawImage(source.canvas, 0, 0);
+			context.restore();
+			return target;
+		});
+		return this;
+	}
+	composite(inputs) {
+		this.raster = this.raster.then(async (target) => {
+			const context = getBrowserContext(target.canvas);
+			for (const input of inputs) {
+				const source = await this.decode(input.input);
+				context.drawImage(source.canvas, input.left, input.top);
+			}
+			return target;
+		});
+		return this;
+	}
+	async metadata() {
+		const raster = await this.raster;
+		return {
+			width: raster.width,
+			height: raster.height,
+			channels: 4,
+			hasAlpha: true
+		};
+	}
+	async toBuffer(options) {
+		const raster = await this.raster;
+		if (options?.resolveWithObject) {
+			const data = getBrowserContext(raster.canvas).getImageData(0, 0, raster.width, raster.height).data;
+			return {
+				data: new Uint8Array(data),
+				info: {
+					width: raster.width,
+					height: raster.height,
+					channels: 4
+				}
+			};
+		}
+		if (this.rawOutput) return new Uint8Array(getBrowserContext(raster.canvas).getImageData(0, 0, raster.width, raster.height).data);
+		return canvasToPng(raster.canvas);
+	}
+	async toFile(path) {
+		const raster = await this.raster;
+		await this.write(path, await canvasToPng(raster.canvas));
+	}
+};
+function createBrowserImageEncoder(sourceFileSystem, outputFileSystem) {
+	const decode = (bytes) => decodeRaster(bytes, imageMimeTypeFromBytes(bytes));
+	return (input) => {
+		return new BrowserImagePipeline(typeof input === "string" ? sourceFileSystem.readFileRaw(input).then((bytes) => decodeRaster(bytes, imageMimeType(input))) : input instanceof Uint8Array ? decode(input) : Promise.resolve(createRaster(input.create.width, input.create.height, input.create.background)), decode, outputFileSystem.writeFileRaw);
+	};
+}
+//#endregion
+//#region src/adapters/web/publish.ts
+function createTrackingFileSystem(fileSystem, files) {
+	return {
+		join: (...paths) => fileSystem.join(...paths),
+		mkdir: (path) => fileSystem.mkdir(path),
+		writeFileRaw: async (path, data) => {
+			await fileSystem.writeFileRaw(path, data);
+			files.set(path, data.byteLength);
+		}
+	};
+}
+function createDiagnosticLogger(logger, diagnostics) {
+	return {
+		debug(message) {
+			diagnostics.push({
+				level: "debug",
+				message
+			});
+			logger.debug(message);
+		},
+		info(message) {
+			diagnostics.push({
+				level: "info",
+				message
+			});
+			logger.info(message);
+		},
+		warn(message) {
+			diagnostics.push({
+				level: "warning",
+				message
+			});
+			logger.warn(message);
+		},
+		error(message) {
+			diagnostics.push({
+				level: "error",
+				message
+			});
+			logger.error(message);
+		}
+	};
+}
+function toResult(success, files, diagnostics) {
+	return {
+		success,
+		files: [...files].map(([path, size]) => ({
+			path,
+			size
+		})),
+		diagnostics
+	};
+}
+function unsupportedSetting(setting, path, message) {
+	return {
+		level: "error",
+		code: "unsupported_publish_setting",
+		setting,
+		path,
+		message
+	};
+}
+/**
+* Publish a loaded FairyGUI project to browser-provided storage.
+*
+* The adapter uses browser Canvas APIs for atlas composition, writes only through
+* the supplied output filesystem, and intentionally skips Node publish plugins.
+*/
+async function publishBrowser(options) {
+	const files = /* @__PURE__ */ new Map();
+	const diagnostics = [];
+	const root = options.document.getRoot();
+	const previousProjectType = root.getProjectType();
+	const previousLogger = options.document.getLogger();
+	options.document.setLogger(createDiagnosticLogger(previousLogger, diagnostics));
+	try {
+		if (options.projectType !== "layabox") throw new Error(`publishBrowser: unsupported project type "${String(options.projectType)}".`);
+		root.setProjectType(ProjectType.LayaBox);
+		const resolved = resolvePublishOptions(options.document, {
+			compressed: options.compressed,
+			packages: options.packages,
+			atlas: options.atlas
+		});
+		if (!/^[A-Za-z0-9][A-Za-z0-9._-]*$/.test(resolved.fileExtension)) {
+			diagnostics.push(unsupportedSetting("fileExtension", "settings.publish.fileExtension", `publishBrowser: unsupported fileExtension "${resolved.fileExtension}".`));
+			return toResult(false, files, diagnostics);
+		}
+		const selectedPackageNames = options.packages?.length ? new Set(options.packages) : null;
+		const selectedPackages = root.listPackages().filter((pkg) => !selectedPackageNames || selectedPackageNames.has(pkg.getName()));
+		if (resolveCodeGenerationSettings(options.document).allowGenCode) {
+			const packageIndex = selectedPackages.findIndex((pkg) => pkg.getGenCode());
+			if (packageIndex >= 0) {
+				const pkg = selectedPackages[packageIndex];
+				diagnostics.push(unsupportedSetting("codeGeneration", `packages[${root.listPackages().indexOf(pkg)}].publish.genCode`, `publishBrowser: code generation requested by package "${pkg.getName()}" is not supported.`));
+				return toResult(false, files, diagnostics);
+			}
+		}
+		assertBrowserImageSupport();
+		const outputFileSystem = createTrackingFileSystem(options.outputFileSystem, files);
+		const sourceAssetsPath = options.sourceFileSystem.join(options.document.getProjectDir(), "assets");
+		await options.document.transform(publish({
+			output: options.output,
+			compressed: resolved.compressed,
+			fileExtension: resolved.fileExtension,
+			packages: options.packages,
+			branch: options.branch,
+			basePath: sourceAssetsPath,
+			encoder: createBrowserImageEncoder(options.sourceFileSystem, outputFileSystem),
+			atlas: {
+				...options.atlas,
+				readFileRaw: (path) => options.sourceFileSystem.readFileRaw(path)
+			},
+			fs: outputFileSystem,
+			plugins: [],
+			codeGeneration: false
+		}));
+		return toResult(true, files, diagnostics);
+	} catch (error) {
+		diagnostics.push({
+			level: "error",
+			code: "publish_failed",
+			message: error instanceof Error ? error.message : String(error)
+		});
+		return toResult(false, files, diagnostics);
+	} finally {
+		root.setProjectType(previousProjectType);
+		options.document.setLogger(previousLogger);
+	}
+}
+//#endregion
+export { publishBrowser };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfairygui/functions",
-  "version": "0.2.0-alpha.7",
+  "version": "0.2.0",
   "description": "FairyGUI Headless Authoring SDK — composable transform functions.",
   "author": "OpenFairyGUI Contributors",
   "license": "MIT",
@@ -38,6 +38,26 @@
         "types": "./dist/uam-transaction.d.ts",
         "default": "./dist/uam-transaction.js"
       }
+    },
+    "./node": {
+      "require": {
+        "types": "./dist/node.d.cts",
+        "default": "./dist/node.cjs"
+      },
+      "default": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      }
+    },
+    "./web": {
+      "require": {
+        "types": "./dist/web.d.cts",
+        "default": "./dist/web.cjs"
+      },
+      "default": {
+        "types": "./dist/web.d.ts",
+        "default": "./dist/web.js"
+      }
     }
   },
   "files": [
@@ -53,14 +73,19 @@
     "publish"
   ],
   "dependencies": {
-    "@openfairygui/core": "0.2.0-alpha.7"
+    "fast-xml-parser": "^5.0.0",
+    "jiti": "^2.6.1",
+    "@openfairygui/core": "0.2.0"
+  },
+  "optionalDependencies": {
+    "sharp": ">=0.33.0"
   },
   "devDependencies": {
     "ava": "^7.0.0",
     "tsx": "^4.0.0"
   },
   "scripts": {
-    "build": "tsdown src/index.ts src/uam-transaction.ts --format esm,cjs --platform neutral --env.PACKAGE_VERSION=$npm_package_version",
-    "build:watch": "tsdown src/index.ts src/uam-transaction.ts --watch --format esm,cjs --platform neutral --env.PACKAGE_VERSION=$npm_package_version"
+    "build": "tsdown src/index.ts src/uam-transaction.ts src/node.ts src/web.ts --format esm,cjs --platform neutral",
+    "build:watch": "tsdown src/index.ts src/uam-transaction.ts src/node.ts src/web.ts --watch --format esm,cjs --platform neutral"
   }
 }

package/src/adapters/node/plugins.ts

@@ -0,0 +1,82 @@
+import type { Document } from '@openfairygui/core';
+import {
+	formatPluginError,
+	type LoadedPlugin,
+	type Plugin,
+	type PluginManifest,
+	type PluginModule,
+} from '../../plugins/types.js';
+
+interface PluginPackageJson extends Partial<PluginManifest> {
+	name?: string;
+	main?: string;
+}
+
+// Keep Node builtins out of the neutral bundle resolver while still loading plugins in Node.
+const importNative = new Function('id', 'return import(id)') as <T>(id: string) => Promise<T>;
+
+export async function loadPlugins(doc: Document, pluginsDir: string): Promise<LoadedPlugin[]> {
+	if (!pluginsDir) return [];
+
+	const fs = await importNative<typeof import('node:fs/promises')>('node:fs/promises');
+	const path = await importNative<typeof import('node:path')>('node:path');
+	let entries: Array<{ name: string; isDirectory(): boolean }>;
+	try {
+		entries = await fs.readdir(pluginsDir, { withFileTypes: true });
+	} catch {
+		return [];
+	}
+
+	const plugins: LoadedPlugin[] = [];
+	for (const entry of entries) {
+		if (!entry.isDirectory()) continue;
+		const pluginDir = path.join(pluginsDir, entry.name);
+		try {
+			const manifest = await readPluginManifest(fs, path, pluginDir);
+			if (!manifest) continue;
+
+			const mainPath = resolvePluginMain(path, pluginDir, manifest);
+			const plugin = await loadPlugin(mainPath);
+			plugins.push({ name: manifest.name, plugin });
+		} catch (error) {
+			doc.getLogger().warn(`publish: Plugin "${entry.name}" was skipped: ${formatPluginError(error)}`);
+		}
+	}
+
+	return plugins;
+}
+
+async function readPluginManifest(
+	fs: typeof import('node:fs/promises'),
+	path: typeof import('node:path'),
+	pluginDir: string,
+): Promise<PluginPackageJson | null> {
+	const manifestPath = path.join(pluginDir, 'package.json');
+	const content = await fs.readFile(manifestPath, 'utf-8');
+	const manifest = JSON.parse(content) as PluginPackageJson;
+	if (!manifest.name) throw new Error(`Codegen plugin at ${pluginDir} is missing package.json name.`);
+	if (!manifest.main) throw new Error(`Codegen plugin "${manifest.name}" is missing package.json main.`);
+	return manifest;
+}
+
+function resolvePluginMain(path: typeof import('node:path'), pluginDir: string, manifest: PluginPackageJson): string {
+	const mainPath = path.resolve(pluginDir, manifest.main!);
+	const relative = path.relative(pluginDir, mainPath);
+	if (relative.startsWith('..') || path.isAbsolute(relative)) {
+		throw new Error(`Codegen plugin "${manifest.name}" main must resolve inside its plugin directory.`);
+	}
+	return mainPath;
+}
+
+async function loadPlugin(mainPath: string): Promise<Plugin> {
+	const { createJiti } = await importNative<typeof import('jiti')>('jiti');
+	const jiti = createJiti(import.meta.url);
+	const mod = await jiti.import<PluginModule>(mainPath);
+	const defaultExport = mod.default;
+	const plugin = isObject(defaultExport) ? defaultExport : mod;
+	return plugin as Plugin;
+}
+
+function isObject(value: unknown): value is Record<string, unknown> {
+	return value !== null && typeof value === 'object';
+}