babylonjs-editor-cli 5.0.0 → 5.0.1

package/esbuild.mjs

@@ -1,57 +0,0 @@
-import esbuild from "esbuild";
-
-import { argv, exit } from "node:process";
-import { readFile } from "node:fs/promises";
-
-const args = argv.slice(2);
-const isWatch = args.includes("--watch");
-
-const replaceImportMetaDirname = {
-	name: "replaceImportMetaDirname",
-	setup(build) {
-		build.onLoad({ filter: /.*/ }, async (args) => {
-			const source = await readFile(args.path, "utf8");
-
-			const transformedSource = source.replace(/import.meta.dirname/g, '"__dirname"');
-
-			return {
-				loader: "default",
-				contents: transformedSource,
-			};
-		});
-	},
-};
-
-const mainBuildOptions = {
-	entryPoints: ["./src/export.mts"],
-	bundle: true,
-	platform: "node",
-	target: "node20", // target version of Node.js
-	format: "cjs", // output format as CommonJS
-	outfile: "./build/index.node.js",
-	treeShaking: false,
-	loader: {
-		".mts": "ts",
-	},
-	keepNames: true,
-	minify: !isWatch,
-	plugins: [replaceImportMetaDirname],
-};
-
-if (args.includes("--watch")) {
-	esbuild
-		.context(mainBuildOptions)
-		.then(async (buildcontext) => {
-			await buildcontext.watch();
-			console.log("Watching...");
-		})
-		.catch((error) => {
-			console.error(error);
-			exit(1);
-		});
-} else {
-	esbuild.build(mainBuildOptions).catch((error) => {
-		console.error(error);
-		exit(1);
-	});
-}

package/src/export.mts

@@ -1 +0,0 @@
-export { pack, IPackOptions } from "./pack/pack.mjs";

package/src/index.mts

@@ -1,28 +0,0 @@
-import dotEnv from "dotenv";
-import { Command } from "commander";
-
-import packageJson from "../package.json" with { type: "json" };
-
-import { pack } from "./pack/pack.mjs";
-
-dotEnv.config();
-
-const program = new Command();
-
-program
-	.version(packageJson.version)
-	.name("Babylon.js Editor CLI")
-	.description("Babylon.js Editor CLI is a command line interface to help you package your scenes made using the Babylon.js Editor")
-	.option("-h, --help", "display help for command");
-
-program
-	.command("pack")
-	.description("Packs the project located in the specified directory. Current directory is used by default.")
-	.argument("[projectDir]", "The root directory of the project to package", process.cwd())
-	.action((projectDir: string) => {
-		pack(projectDir, {
-			optimize: true,
-		});
-	});
-
-program.parse();

package/src/pack/assets/assets.mts

@@ -1,46 +0,0 @@
-import { cpus } from "node:os";
-import { extname, join } from "node:path/posix";
-
-import { normalizedGlob } from "../../tools/fs.mjs";
-
-import { processAssetFile } from "./process.mjs";
-
-export interface ICreateAssetsOptions {
-	projectDir: string;
-	publicDir: string;
-	baseAssetsDir: string;
-	outputAssetsDir: string;
-	optimize: boolean;
-	exportedAssets: string[];
-	cache: Record<string, string>;
-	compressedTexturesEnabled: boolean;
-}
-
-export async function createAssets(options: ICreateAssetsOptions) {
-	const files = await normalizedGlob(join(options.baseAssetsDir, "**/*"), {
-		nodir: true,
-		ignore: {
-			childrenIgnored: (p) => extname(p.name) === ".scene",
-		},
-	});
-
-	const promises: Promise<void>[] = [];
-
-	const cpusCount = cpus().length;
-	console.log(`Using ${cpusCount} cpus to process assets...`);
-
-	for (const file of files) {
-		if (promises.length >= cpusCount) {
-			await Promise.all(promises);
-			promises.length = 0;
-		}
-
-		promises.push(
-			processAssetFile(file, {
-				...options,
-			})
-		);
-	}
-
-	await Promise.all(promises);
-}

package/src/pack/assets/ktx.mts

@@ -1,158 +0,0 @@
-import { basename, extname, join, dirname } from "node:path/posix";
-
-import fs from "fs-extra";
-import { PNG } from "pngjs";
-import { createReadStream } from "node:fs";
-
-import { executeAsync } from "../../tools/process.mjs";
-import { pvrTexToolAbsolutePath } from "../../tools/ktx.mjs";
-
-export type KTXToolsType = "-astc.ktx" | "-dxt.ktx" | "-pvrtc.ktx" | "-etc1.ktx" | "-etc2.ktx";
-
-export const allKtxFormats: KTXToolsType[] = ["-astc.ktx", "-dxt.ktx", "-pvrtc.ktx", "-etc1.ktx", "-etc2.ktx"];
-
-export const ktxSupportedextensions: string[] = [".png", ".jpg", ".jpeg", ".bmp"];
-
-/**
- * Returns the absolute path to the compressed textures CLI path (PVRTexTool).
- * The value is retrieved from the local storage so it's per computer and not per project.
- */
-export function getCompressedTexturesCliPath() {
-	let value = "";
-
-	try {
-		value = localStorage.getItem("editor-compressed-textures-cli-path") ?? "";
-	} catch (e) {
-		// Catch silently.
-	}
-
-	return value || null;
-}
-
-/**
- * Sets the absolute path to the compressed textures CLI path (PVRTexTool).
- * The value is stored in the local storage so it's per computer and not per project.
- */
-export function setCompressedTexturesCliPath(absolutePath: string) {
-	try {
-		localStorage.setItem("editor-compressed-textures-cli-path", absolutePath);
-	} catch (e) {
-		// Catch silently.
-	}
-}
-
-/**
- * Returns the filename of the compressed texture according to the given path and the destination format.
- * @param path defines the path of the texture to get its final name.
- * @param format defines the destination format of the texture.
- * @example image.png -> image-asct.ktx
- */
-export function getCompressedTextureFilename(path: string, format: KTXToolsType) {
-	return `${path.substring(0, path.lastIndexOf("."))}${format}`;
-}
-
-export type CompressFileToKtxOptions = {
-	format: KTXToolsType;
-	force?: boolean;
-	exportedAssets?: string[];
-	destinationFolder?: string;
-};
-
-export async function compressFileToKtx(absolutePath: string, options: Partial<CompressFileToKtxOptions>): Promise<void> {
-	if (options.format) {
-		await compressFileToKtxFormat(absolutePath, options as CompressFileToKtxOptions);
-	} else {
-		await Promise.all(
-			allKtxFormats.map((f) =>
-				compressFileToKtxFormat(absolutePath, {
-					...options,
-					format: f,
-				})
-			)
-		);
-	}
-}
-
-export async function compressFileToKtxFormat(absolutePath: string, options: CompressFileToKtxOptions): Promise<string | null> {
-	const name = basename(absolutePath);
-	const extension = extname(name).toLocaleLowerCase();
-
-	if (!ktxSupportedextensions.includes(extension)) {
-		return null;
-	}
-
-	const filename = getCompressedTextureFilename(name, options.format);
-
-	options.destinationFolder ??= dirname(absolutePath);
-	options.destinationFolder = join(options.destinationFolder, filename);
-
-	// if (!editor.state.compressedTexturesEnabled) {
-	// 	options.exportedAssets?.push(options.destinationFolder);
-	// 	return null;
-	// }
-
-	if ((await fs.pathExists(options.destinationFolder)) && !options.force) {
-		options.exportedAssets?.push(options.destinationFolder);
-		return options.destinationFolder;
-	}
-
-	const hasAlpha = await new Promise<boolean>((resolve) => {
-		const stream = createReadStream(absolutePath);
-
-		stream
-			.pipe(new PNG())
-			.on("metadata", (p) => {
-				resolve(p.alpha);
-				stream.close();
-			})
-			.on("error", () => {
-				resolve(false);
-				stream.close();
-			});
-	});
-
-	if (!pvrTexToolAbsolutePath) {
-		return null;
-	}
-
-	let command: string | null = null;
-	switch (options.format) {
-		case "-astc.ktx":
-			command = `"${pvrTexToolAbsolutePath}" -i "${absolutePath}" -flip y -pot + -m -dither -ics lRGB -f ASTC_8x8,UBN,lRGB -q astcveryfast -o "${options.destinationFolder}"`;
-			break;
-
-		case "-dxt.ktx":
-			command = `"${pvrTexToolAbsolutePath}" -i "${absolutePath}" -flip y -pot + -m -ics lRGB ${hasAlpha ? "-l" : ""} -f ${hasAlpha ? "BC2" : "BC1"},UBN,lRGB -o "${options.destinationFolder}"`;
-			break;
-
-		case "-pvrtc.ktx":
-			command = `"${pvrTexToolAbsolutePath}" -i "${absolutePath}" -flip y -pot + -square + -m -dither -ics lRGB ${hasAlpha ? "-l" : ""} -f ${hasAlpha ? "PVRTCI_2BPP_RGBA" : "PVRTCI_2BPP_RGB"},UBN,lRGB -q pvrtcfastest -o "${options.destinationFolder}"`;
-			break;
-
-		case "-etc1.ktx":
-			command = `"${pvrTexToolAbsolutePath}" -i "${absolutePath}" -flip y -pot + -m -dither -ics lRGB -f ETC1,UBN,lRGB -q etcfast -o "${options.destinationFolder}"`;
-			break;
-
-		case "-etc2.ktx":
-			command = `"${pvrTexToolAbsolutePath}" -i "${absolutePath}" -flip y -pot + -m -dither -ics lRGB -f ${hasAlpha ? "ETC2_RGBA" : "ETC2_RGB"},UBN,lRGB -q etcfast -o "${options.destinationFolder}"`;
-			break;
-	}
-
-	if (!command) {
-		return null;
-	}
-
-	console.log(`Compressing image "${filename}"`);
-
-	try {
-		await executeAsync(command);
-		console.log(`Compressed image "${filename}"`);
-		options.exportedAssets?.push(options.destinationFolder);
-
-		return options.destinationFolder;
-	} catch (e) {
-		console.error(`Failed to compress image "${filename}"`);
-	}
-
-	return null;
-}

package/src/pack/assets/material.mts

@@ -1,86 +0,0 @@
-import { join } from "node:path/posix";
-
-import fs from "fs-extra";
-
-import { extractTextureAssetFromDataString, extractTextureAssetFromUrl } from "../../tools/extract.mjs";
-
-import { compressFileToKtx } from "./ktx.mjs";
-import { getExtractedTextureOutputPath } from "./texture.mjs";
-
-export interface IProcessExportedMaterialOptions {
-	force: boolean;
-	publicDir: string;
-	exportedAssets: string[];
-	optimize: boolean;
-}
-
-export async function processExportedMaterial(absolutePath: string, options: IProcessExportedMaterialOptions) {
-	const materialData = await fs.readJSON(absolutePath);
-	if (materialData.customType !== "BABYLON.NodeMaterial") {
-		return;
-	}
-
-	const extractedTexturesOutputPath = getExtractedTextureOutputPath(options.publicDir);
-	await fs.ensureDir(extractedTexturesOutputPath);
-
-	const relativePaths = await extractNodeMaterialTextures(materialData, {
-		extractedTexturesOutputPath,
-	});
-
-	await fs.writeJSON(absolutePath, materialData, {
-		encoding: "utf-8",
-	});
-
-	await Promise.all(
-		relativePaths.map(async (relativePath) => {
-			const finalPath = join(options.publicDir, relativePath);
-
-			options.exportedAssets.push(finalPath);
-
-			await compressFileToKtx(finalPath, {
-				force: options.force,
-				exportedAssets: options.exportedAssets,
-			});
-		})
-	);
-}
-
-export interface IExtractNodeMaterialTexturesOptions {
-	extractedTexturesOutputPath: string;
-}
-
-export async function extractNodeMaterialTextures(materialData: any, options: IExtractNodeMaterialTexturesOptions) {
-	const blocks = materialData.blocks.filter(
-		(block: any) => (block.customType === "BABYLON.TextureBlock" || block.customType === "BABYLON.ImageSourceBlock") && block.texture?.name
-	);
-
-	const relativePaths: string[] = [];
-
-	await Promise.all(
-		blocks.map(async (block: any) => {
-			if (block.texture?.name?.startsWith("http://") || block.texture.name.startsWith("https://")) {
-				const relativePath = await extractTextureAssetFromUrl(block.texture.name, {
-					...options,
-				});
-
-				if (relativePath) {
-					relativePaths.push(relativePath);
-					block.texture.name = block.texture.url = relativePath;
-				}
-			}
-
-			if (block.texture.name?.startsWith("data:")) {
-				const relativePath = await extractTextureAssetFromDataString(block.texture.name, {
-					...options,
-				});
-
-				if (relativePath) {
-					relativePaths.push(relativePath);
-					block.texture.name = block.texture.url = relativePath;
-				}
-			}
-		})
-	);
-
-	return relativePaths;
-}

package/src/pack/assets/particle-system.mts

@@ -1,109 +0,0 @@
-import { join } from "node:path/posix";
-
-import fs from "fs-extra";
-
-import { extractTextureAssetFromDataString, extractTextureAssetFromUrl } from "../../tools/extract.mjs";
-
-import { compressFileToKtx } from "./ktx.mjs";
-import { getExtractedTextureOutputPath } from "./texture.mjs";
-
-export interface IProcessExportedMaterialOptions {
-	force: boolean;
-	publicDir: string;
-	exportedAssets: string[];
-	optimize: boolean;
-}
-
-export async function processExportedNodeParticleSystemSet(absolutePath: string, options: IProcessExportedMaterialOptions) {
-	const particleSystemData = await fs.readJSON(absolutePath);
-	if (particleSystemData.customType !== "BABYLON.NodeParticleSystemSet") {
-		return;
-	}
-
-	const extractedTexturesOutputPath = getExtractedTextureOutputPath(options.publicDir);
-	await fs.ensureDir(extractedTexturesOutputPath);
-
-	const relativePaths = await extractNodeParticleSystemSetTextures(particleSystemData, {
-		extractedTexturesOutputPath,
-	});
-
-	await fs.writeJSON(absolutePath, particleSystemData, {
-		encoding: "utf-8",
-	});
-
-	await Promise.all(
-		relativePaths.map(async (relativePath) => {
-			const finalPath = join(options.publicDir, relativePath);
-
-			options.exportedAssets.push(finalPath);
-
-			if (options.optimize) {
-				await compressFileToKtx(finalPath, {
-					force: options.force,
-					exportedAssets: options.exportedAssets,
-				});
-			}
-		})
-	);
-}
-
-export interface IExtractParticleSystemTexturesOptions {
-	extractedTexturesOutputPath: string;
-}
-
-export async function extractParticleSystemTextures(particleSystemData: any, options: IExtractParticleSystemTexturesOptions) {
-	let relativePath: string | null = null;
-
-	if (particleSystemData.texture?.name.startsWith("http://") || particleSystemData.texture?.name.startsWith("https://")) {
-		relativePath = await extractTextureAssetFromUrl(particleSystemData.texture.name, {
-			...options,
-		});
-	} else if (particleSystemData.texture?.name.startsWith("data:")) {
-		relativePath = await extractTextureAssetFromDataString(particleSystemData.texture.name, {
-			...options,
-		});
-	}
-
-	if (relativePath) {
-		particleSystemData.texture.name = relativePath;
-		particleSystemData.texture.url = particleSystemData.texture.name;
-	}
-
-	return relativePath;
-}
-
-export async function extractNodeParticleSystemSetTextures(particleSystemData: any, options: IExtractParticleSystemTexturesOptions) {
-	const blocks = particleSystemData.blocks.filter((block) => block.customType === "BABYLON.ParticleTextureSourceBlock");
-
-	const relativePaths: string[] = [];
-
-	await Promise.all(
-		blocks.map(async (block: any) => {
-			if (block.url?.startsWith("http://") || block.url?.startsWith("https://")) {
-				const relativePath = await extractTextureAssetFromUrl(block.url, {
-					...options,
-				});
-
-				if (relativePath) {
-					relativePaths.push(relativePath);
-					block.url = `/scene/${relativePath}`;
-				}
-			}
-
-			if (block.textureDataUrl?.startsWith("data:")) {
-				const relativePath = await extractTextureAssetFromDataString(block.textureDataUrl, {
-					...options,
-				});
-
-				if (relativePath) {
-					relativePaths.push(relativePath);
-					delete block.textureDataUrl;
-					block.url = `/scene/${relativePath}`;
-					block.serializedCachedData = false;
-				}
-			}
-		})
-	);
-
-	return relativePaths;
-}

package/src/pack/assets/process.mts

@@ -1,102 +0,0 @@
-import { basename, extname, join } from "node:path/posix";
-
-import fs from "fs-extra";
-
-import { compressFileToKtx } from "./ktx.mjs";
-import { ICreateAssetsOptions } from "./assets.mjs";
-import { processExportedTexture } from "./texture.mjs";
-import { processExportedMaterial } from "./material.mjs";
-import { processExportedNodeParticleSystemSet } from "./particle-system.mjs";
-
-const supportedImagesExtensions: string[] = [".jpg", ".jpeg", ".webp", ".png", ".bmp"];
-const supportedCubeTexturesExtensions: string[] = [".env", ".dds"];
-const supportedAudioExtensions: string[] = [".mp3", ".wav", ".wave", ".ogg"];
-const supportedJsonExtensions: string[] = [".material", ".gui", ".cinematic", ".npss", ".json"];
-const supportedMiscExtensions: string[] = [".3dl", ".exr", ".hdr"];
-
-const supportedExtensions: string[] = [
-	...supportedImagesExtensions,
-	...supportedCubeTexturesExtensions,
-	...supportedAudioExtensions,
-	...supportedJsonExtensions,
-	...supportedMiscExtensions,
-];
-
-export interface IProcessAssetFileOptions extends ICreateAssetsOptions {
-	outputAssetsDir: string;
-	exportedAssets: string[];
-	optimize: boolean;
-	cache: Record<string, string>;
-	compressedTexturesEnabled: boolean;
-}
-
-export async function processAssetFile(file: string, options: IProcessAssetFileOptions) {
-	const isNavMesh = file.includes(".navmesh");
-	const extension = extname(file).toLocaleLowerCase();
-
-	if (!isNavMesh && !supportedExtensions.includes(extension)) {
-		return;
-	}
-
-	if (basename(file).startsWith("editor_preview")) {
-		return;
-	}
-
-	const relativePath = file.replace(join(options.projectDir, "/"), "");
-	const split = relativePath.split("/");
-
-	let path = "";
-	for (let i = 0; i < split.length - 1; ++i) {
-		try {
-			await fs.ensureDir(join(options.publicDir, path, split[i]));
-		} catch (e) {
-			// Catch silently.
-		}
-
-		path = join(path, split[i]);
-	}
-
-	let isNewFile = false;
-
-	const fileStat = await fs.stat(file);
-	const hash = fileStat.mtimeMs.toString();
-
-	isNewFile = !options.cache[relativePath] || options.cache[relativePath] !== hash;
-
-	options.cache[relativePath] = hash;
-
-	const finalPath = join(options.publicDir, relativePath);
-	const finalPathExists = await fs.pathExists(finalPath);
-
-	if (isNewFile || !finalPathExists) {
-		await fs.copyFile(file, finalPath);
-	}
-
-	options.exportedAssets.push(finalPath);
-
-	if (options.optimize && options.compressedTexturesEnabled) {
-		await compressFileToKtx(finalPath, {
-			force: isNewFile,
-			exportedAssets: options.exportedAssets,
-		});
-	}
-
-	if (options.optimize) {
-		if (supportedImagesExtensions.includes(extension)) {
-			await processExportedTexture(finalPath, {
-				...options,
-				force: isNewFile,
-			});
-		} else if (extension === ".material") {
-			await processExportedMaterial(finalPath, {
-				...options,
-				force: isNewFile,
-			});
-		} else if (extension === ".npss") {
-			await processExportedNodeParticleSystemSet(finalPath, {
-				...options,
-				force: isNewFile,
-			});
-		}
-	}
-}

package/src/pack/assets/texture.mts

@@ -1,91 +0,0 @@
-import { basename, dirname, extname, join } from "node:path/posix";
-
-import sharp from "sharp";
-import fs from "fs-extra";
-
-import { getPowerOfTwoUntil } from "../../tools/scalar.mjs";
-
-import { compressFileToKtx } from "./ktx.mjs";
-
-export function getExtractedTextureOutputPath(publicDir: string) {
-	return join(publicDir, "assets", "editor-generated_extracted-textures");
-}
-
-export interface IComputeExportedTextureOptions {
-	force: boolean;
-	exportedAssets: string[];
-	compressedTexturesEnabled: boolean;
-}
-
-export async function processExportedTexture(absolutePath: string, options: IComputeExportedTextureOptions): Promise<void> {
-	const extension = extname(absolutePath).toLocaleLowerCase();
-
-	const metadata = await sharp(absolutePath).metadata();
-	if (!metadata.width || !metadata.height) {
-		return console.error(`Failed to compute exported image "${absolutePath}". Image metadata is invalid.`);
-	}
-
-	const width = metadata.width;
-	const height = metadata.height;
-
-	const isPowerOfTwo = width === getPowerOfTwoUntil(width) || height === getPowerOfTwoUntil(height);
-
-	type _DownscaledTextureSize = {
-		width: number;
-		height: number;
-	};
-
-	const availableSizes: _DownscaledTextureSize[] = [];
-
-	let midWidth = (width * 0.66) >> 0;
-	let midHeight = (height * 0.66) >> 0;
-
-	if (isPowerOfTwo) {
-		midWidth = getPowerOfTwoUntil(midWidth);
-		midHeight = getPowerOfTwoUntil(midHeight);
-	}
-
-	availableSizes.push({
-		width: midWidth,
-		height: midHeight,
-	});
-
-	let lowWidth = (width * 0.33) >> 0;
-	let lowHeight = (height * 0.33) >> 0;
-
-	if (isPowerOfTwo) {
-		lowWidth = getPowerOfTwoUntil(lowWidth);
-		lowHeight = getPowerOfTwoUntil(lowHeight);
-	}
-
-	availableSizes.push({
-		width: lowWidth,
-		height: lowHeight,
-	});
-
-	for (const size of availableSizes) {
-		const nameWithoutExtension = basename(absolutePath).replace(extension, "");
-		const finalName = `${nameWithoutExtension}_${size.width}_${size.height}${extension}`;
-		const finalPath = join(dirname(absolutePath), finalName);
-
-		options.exportedAssets.push(finalPath);
-
-		if (options.force || !(await fs.pathExists(finalPath))) {
-			try {
-				const buffer = await sharp(absolutePath).resize(size.width, size.height).toBuffer();
-
-				await fs.writeFile(finalPath, buffer);
-
-				console.log(`Exported scaled texture "${finalName}"`);
-			} catch (e) {
-				console.error(`Failed to export image scaled image "${finalName}"`);
-			}
-		}
-
-		if (options.compressedTexturesEnabled) {
-			await compressFileToKtx(finalPath, {
-				...options,
-			});
-		}
-	}
-}